Struct style::computed_value_flags::ComputedValueFlags

#[repr(C)]
pub struct ComputedValueFlags(u32);

Misc information about a given computed style.

All flags are currently inherited for text, pseudo elements, and anonymous boxes, see StyleBuilder::for_inheritance and its callsites. If we ever want to add some flags that shouldn’t inherit for them, we might want to add a function to handle this.

Tuple Fields

0: u32

Implementations

impl ComputedValueFlags

pub const HAS_TEXT_DECORATION_LINES: Self = _

Whether the style or any of the ancestors has a text-decoration-line property that should get propagated to descendants.

text-decoration-line is a reset property, but gets propagated in the frame/box tree.

pub const SHOULD_SUPPRESS_LINEBREAK: Self = _

Whether line break inside should be suppressed.

If this flag is set, the line should not be broken inside, which means inlines act as if nowrap is set,
element is suppressed, and blocks are inlinized.

This bit is propagated to all children of line participants. It is currently used by ruby to make its content unbreakable.

pub const IS_TEXT_COMBINED: Self = _

A flag used to mark text that that has text-combine-upright.

This is used from Gecko’s layout engine.

pub const IS_RELEVANT_LINK_VISITED: Self = _

A flag used to mark styles under a relevant link that is also visited.

pub const IS_IN_PSEUDO_ELEMENT_SUBTREE: Self = _

A flag used to mark styles which are a pseudo-element or under one.

pub const SELF_OR_ANCESTOR_HAS_CONTAIN_STYLE: Self = _

A flag used to mark styles which have contain:style or under one.

pub const DISPLAY_DEPENDS_ON_INHERITED_STYLE: Self = _

Whether this style’s display property depends on our parent style.

This is important because it may affect our optimizations to avoid computing the style of pseudo-elements, given whether the pseudo-element is generated depends on the display value.

pub const CONTENT_DEPENDS_ON_INHERITED_STYLE: Self = _

Whether this style’s content depends on our parent style.

Important because of the same reason.

pub const INHERITS_RESET_STYLE: Self = _

Whether the child explicitly inherits any reset property.

pub const DEPENDS_ON_SELF_FONT_METRICS: Self = _

Whether any value on our style is font-metric-dependent on our primary font.

pub const DEPENDS_ON_INHERITED_FONT_METRICS: Self = _

Whether any value on our style is font-metric-dependent on the primary font of our parent.

pub const CAN_BE_FRAGMENTED: Self = _

Whether the style or any of the ancestors has a multicol style.

Only used in Servo.

pub const IS_ROOT_ELEMENT_STYLE: Self = _

Whether this style is the style of the document element.

pub const IS_IN_OPACITY_ZERO_SUBTREE: Self = _

Whether this element is inside an opacity: 0 subtree.

pub const HAS_AUTHOR_SPECIFIED_BORDER_BACKGROUND: Self = _

Whether there are author-specified rules for border-* properties (except border-image-*), background-color, or background-image.

TODO(emilio): Maybe do include border-image, see:

https://github.com/w3c/csswg-drafts/issues/4777#issuecomment-604424845

pub const HAS_AUTHOR_SPECIFIED_FONT_FAMILY: Self = _

Whether there are author-specified rules for font-family.

pub const HAS_AUTHOR_SPECIFIED_FONT_SYNTHESIS_WEIGHT: Self = _

Whether there are author-specified rules for font-synthesis-weight.

pub const HAS_AUTHOR_SPECIFIED_FONT_SYNTHESIS_STYLE: Self = _

Whether there are author-specified rules for font-synthesis-style.

pub const HAS_AUTHOR_SPECIFIED_LETTER_SPACING: Self = _

Whether there are author-specified rules for letter-spacing.

pub const HAS_AUTHOR_SPECIFIED_WORD_SPACING: Self = _

Whether there are author-specified rules for word-spacing.

pub const USES_VIEWPORT_UNITS: Self = _

Whether the style depends on viewport units.

pub const USES_VIEWPORT_UNITS_ON_CONTAINER_QUERIES: Self = _

Whether the style depends on viewport units on container queries.

This needs to be a separate flag from USES_VIEWPORT_UNITS because it causes us to re-match the style (rather than re-cascascading it, which is enough for other uses of viewport units).

pub const SELF_OR_ANCESTOR_HAS_SIZE_CONTAINER_TYPE: Self = _

A flag used to mark styles which have container-type of size or inline-size, or under one.

pub const USES_CONTAINER_UNITS: Self = _

Whether the style uses container query units, in which case the style depends on the container’s size and we can’t reuse it across cousins (without double-checking the container at least).

pub const HAS_AUTHOR_SPECIFIED_TEXT_COLOR: Self = _

Whether there are author-specific rules for text color.

pub const CONSIDERED_NONTRIVIAL_SCOPED_STYLE: Self = _

Whether this style considered a scope style rule.

impl ComputedValueFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl ComputedValueFlags

pub const fn iter(&self) -> Iter<ComputedValueFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<ComputedValueFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl ComputedValueFlags

fn inherited_flags() -> Self

Flags that are unconditionally propagated to descendants.

fn maybe_inherited_flags() -> Self

Flags that may be propagated to descendants.

fn cascade_input_flags() -> Self

Flags that are an input to the cascade.

pub fn inherited(self) -> Self

Returns the flags that are always propagated to descendants.

See StyleAdjuster::set_bits and StyleBuilder.

pub fn maybe_inherited(self) -> Self

Flags that are conditionally propagated to descendants, just to handle properly style invalidation.

pub fn for_cascade_inputs(self) -> Self

Flags that are an input to the cascade.

Trait Implementations

impl Binary for ComputedValueFlags

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

Formats the value using the given formatter.

impl BitAnd for ComputedValueFlags

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = ComputedValueFlags

The resulting type after applying the & operator.

impl BitAndAssign for ComputedValueFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for ComputedValueFlags

fn bitor(self, other: ComputedValueFlags) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = ComputedValueFlags

The resulting type after applying the | operator.

impl BitOrAssign for ComputedValueFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for ComputedValueFlags

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = ComputedValueFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for ComputedValueFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for ComputedValueFlags

fn clone(&self) -> ComputedValueFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ComputedValueFlags

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

Formats the value using the given formatter.

impl Default for ComputedValueFlags

fn default() -> Self

Returns the “default value” for a type.

impl Extend<ComputedValueFlags> for ComputedValueFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for ComputedValueFlags

const FLAGS: &'static [Flag<ComputedValueFlags>] = _

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> ComputedValueFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<ComputedValueFlags> for ComputedValueFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for ComputedValueFlags

type Item = ComputedValueFlags

The type of the elements being iterated over.

type IntoIter = Iter<ComputedValueFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for ComputedValueFlags

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

Formats the value using the given formatter.

impl MallocSizeOf for ComputedValueFlags

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 Not for ComputedValueFlags

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = ComputedValueFlags

The resulting type after applying the ! operator.

impl Octal for ComputedValueFlags

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

Formats the value using the given formatter.

impl PartialEq for ComputedValueFlags

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Sub for ComputedValueFlags

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = ComputedValueFlags

The resulting type after applying the - operator.

impl SubAssign for ComputedValueFlags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for ComputedValueFlags

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

Formats the value using the given formatter.

impl Copy for ComputedValueFlags

impl Eq for ComputedValueFlags

impl StructuralPartialEq for ComputedValueFlags