Struct style::values::computed::length_percentage::LengthPercentage

#[repr(transparent)]
pub struct LengthPercentage(LengthPercentageUnion);

A <length-percentage> value. This can be either a <length>, a <percentage>, or a combination of both via calc().

cbindgen:private-default-tagged-enum-constructor=false cbindgen:derive-mut-casts=true

https://drafts.csswg.org/css-values-4/#typedef-length-percentage

The tag is stored in the lower two bits.

We need to use a struct instead of the union directly because unions with Drop implementations are unstable, looks like.

Also we need the union and the variants to be pub (even though the member is private) so that cbindgen generates it. They’re not part of the public API otherwise.

Tuple Fields

0: LengthPercentageUnion

Implementations

impl LengthPercentage

pub fn one() -> Self

1px length value for SVG defaults

pub fn zero_percent() -> Self

0%

fn to_calc_node(&self) -> Cow<'_, CalcNode>

fn map_lengths(&self, map_fn: impl FnMut(Length) -> Length) -> Self

pub fn new_length(length: Length) -> Self

Constructs a length value.

pub fn new_percent(percentage: Percentage) -> Self

Constructs a percentage value.

pub fn hundred_percent_minus(v: Self, clamping_mode: AllowedNumericType) -> Self

Given a LengthPercentage value v, construct the value representing calc(100% - v).

pub fn hundred_percent_minus_list( list: &[&Self], clamping_mode: AllowedNumericType, ) -> Self

Given a list of LengthPercentage values, construct the value representing calc(100% - the sum of the list).

pub fn new_calc(node: CalcNode, clamping_mode: AllowedNumericType) -> Self

Constructs a calc() value.

fn new_calc_unchecked(calc: Box<CalcLengthPercentage>) -> Self

Private version of new_calc() that constructs a calc() variant without checking.

fn tag(&self) -> Tag

fn unpack_mut<'a>(&'a mut self) -> UnpackedMut<'a>

fn unpack<'a>(&'a self) -> Unpacked<'a>

unsafe fn calc_ptr(&self) -> *mut CalcLengthPercentage

fn to_serializable(&self) -> Serializable

fn from_serializable(s: Serializable) -> Self

pub fn is_definitely_zero(&self) -> bool

Returns true if the computed value is absolute 0 or 0%.

pub fn resolve(&self, basis: Length) -> Length

Resolves the percentage.

pub fn percentage_relative_to(&self, basis: Length) -> Length

Resolves the percentage. Just an alias of resolve().

pub fn has_percentage(&self) -> bool

Return whether there’s any percentage in this value.

pub fn to_length(&self) -> Option<Length>

Converts to a <length> if possible.

pub fn to_percentage(&self) -> Option<Percentage>

Converts to a <percentage> if possible.

pub fn to_percentage_of(&self, basis: Length) -> Option<Percentage>

Converts to a <percentage> with given basis. Returns None if the basis is 0.

pub fn to_used_value(&self, containing_length: Au) -> Au

Returns the used value.

pub fn to_pixel_length(&self, containing_length: Au) -> Length

Returns the used value as CSSPixelLength.

pub fn maybe_to_used_value(&self, container_len: Option<Au>) -> Option<Au>

Convert the computed value into used value.

pub fn maybe_percentage_relative_to( &self, container_len: Option<Length>, ) -> Option<Length>

If there are special rules for computing percentages in a value (e.g. the height property), they apply whenever a calc() expression contains percentages.

pub fn clamp_to_non_negative(self) -> Self

Returns the clamped non-negative values.

impl LengthPercentage

pub fn normal() -> Self

Return the normal computed value, which is just zero.

Trait Implementations

impl Animate for LengthPercentage

https://drafts.csswg.org/css-transitions/#animtype-lpcalc https://drafts.csswg.org/css-values-4/#combine-math https://drafts.csswg.org/css-values-4/#combine-mixed

fn animate(&self, other: &Self, procedure: Procedure) -> Result<Self, ()>

Animate a value towards another one, given an animation procedure.

impl Clone for LengthPercentage

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ComputeSquaredDistance for LengthPercentage

fn compute_squared_distance(&self, other: &Self) -> Result<SquaredDistance, ()>

Computes the squared distance between two animatable values.

impl Debug for LengthPercentage

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LengthPercentage

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for LengthPercentage

fn drop(&mut self)

Executes the destructor for this type.

impl MallocSizeOf for LengthPercentage

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl PartialEq for LengthPercentage

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PositionComponent for LengthPercentage

fn is_center(&self) -> bool

Returns if the position component is 50% or center. For pixel lengths, it always returns false.

impl Serialize for LengthPercentage

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl ToAbsoluteLength for LengthPercentage

fn to_pixel_length( &self, containing_len: Option<ComputedLength>, ) -> Result<CSSFloat, ()>

Returns the absolute length as pixel value.

impl ToAnimatedValue for LengthPercentage

type AnimatedValue = LengthPercentage

The type of the animated value.

fn to_animated_value(self, context: &AnimatedContext<'_>) -> Self::AnimatedValue

Converts this value to an animated value.

fn from_animated_value(value: Self::AnimatedValue) -> Self

Converts back an animated value into a computed value.

impl ToAnimatedZero for LengthPercentage

fn to_animated_zero(&self) -> Result<Self, ()>

Returns a value that, when added with an underlying value, will produce the underlying value. This is used for SMIL animation’s “by-animation” where SMIL first interpolates from the zero value to the ‘by’ value, and then adds the result to the underlying value.

impl ToCss for LengthPercentage

fn to_css<W>(&self, dest: &mut CssWriter<'_, W>) -> Result

where W: Write,

Serialize self in CSS syntax, writing to dest.

fn to_css_string(&self) -> String

Serialize self in CSS syntax and return a string.

impl ToResolvedValue for LengthPercentage

type ResolvedValue = LengthPercentage

The resolved value type we’re going to be converted to.

fn to_resolved_value(self, context: &ResolvedContext<'_>) -> Self::ResolvedValue

Convert a resolved value to a resolved value.

fn from_resolved_value(value: Self::ResolvedValue) -> Self

Convert a resolved value to resolved value form.

impl Zero for LengthPercentage

fn zero() -> Self

Returns the zero value.

fn is_zero(&self) -> bool

Returns whether this value is zero.

impl ZeroNoPercent for LengthPercentage

fn is_zero_no_percent(&self) -> bool

So, 0px should return true, but 0% or 1px should return false