Struct style::logical_geometry::WritingMode

#[repr(C)]
pub struct WritingMode {
    bits: u8,
}

Fields

bits: u8

Implementations

impl WritingMode

pub const VERTICAL: Self = _

A vertical writing mode; writing-mode is vertical-rl, vertical-lr, sideways-lr, or sideways-rl.

pub const INLINE_REVERSED: Self = _

The inline flow direction is reversed against the physical direction (i.e. right-to-left or bottom-to-top); writing-mode is sideways-lr or direction is rtl (but not both).

(This bit can be derived from the others, but we store it for convenience.)

pub const VERTICAL_LR: Self = _

A vertical writing mode whose block progression direction is left- to-right; writing-mode is vertical-lr or sideways-lr.

Never set without VERTICAL.

pub const LINE_INVERTED: Self = _

The line-over/line-under sides are inverted with respect to the block-start/block-end edge; writing-mode is vertical-lr.

Never set without VERTICAL and VERTICAL_LR.

pub const RTL: Self = _

direction is rtl.

pub const VERTICAL_SIDEWAYS: Self = _

All text within a vertical writing mode is displayed sideways and runs top-to-bottom or bottom-to-top; set in these cases:

• writing-mode: sideways-rl;
• writing-mode: sideways-lr;

Never set without VERTICAL.

pub const TEXT_SIDEWAYS: Self = _

Similar to VERTICAL_SIDEWAYS, but is set via text-orientation; set in these cases:

• writing-mode: vertical-rl; text-orientation: sideways;
• writing-mode: vertical-lr; text-orientation: sideways;

Never set without VERTICAL.

pub const UPRIGHT: Self = _

Horizontal text within a vertical writing mode is displayed with each glyph upright; set in these cases:

• writing-mode: vertical-rl; text-orientation: upright;
• writing-mode: vertical-lr: text-orientation: upright;

Never set without VERTICAL.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u8) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true if all of the flags in other are contained within self.

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

Inserts or removes the specified flags depending on the passed value.

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

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

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

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

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

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

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

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

impl WritingMode

pub fn new(inheritedbox_style: &InheritedBox) -> Self

Return a WritingMode bitflags from the relevant CSS properties.

pub fn horizontal_tb() -> Self

Returns the horizontal-tb value.

pub fn is_vertical(&self) -> bool

pub fn is_horizontal(&self) -> bool

pub fn is_vertical_lr(&self) -> bool

Assuming .is_vertical(), does the block direction go left to right?

pub fn is_inline_tb(&self) -> bool

Assuming .is_vertical(), does the inline direction go top to bottom?

pub fn is_bidi_ltr(&self) -> bool

pub fn is_sideways(&self) -> bool

pub fn is_upright(&self) -> bool

pub fn line_left_is_inline_start(&self) -> bool

https://drafts.csswg.org/css-writing-modes/#logical-to-physical

Return	line-left is…	line-right is…
true	inline-start	inline-end
false	inline-end	inline-start

pub fn inline_start_physical_side(&self) -> PhysicalSide

pub fn inline_end_physical_side(&self) -> PhysicalSide

pub fn block_start_physical_side(&self) -> PhysicalSide

pub fn block_end_physical_side(&self) -> PhysicalSide

fn physical_sides_to_corner( block_side: PhysicalSide, inline_side: PhysicalSide ) -> PhysicalCorner

pub fn start_start_physical_corner(&self) -> PhysicalCorner

pub fn start_end_physical_corner(&self) -> PhysicalCorner

pub fn end_start_physical_corner(&self) -> PhysicalCorner

pub fn end_end_physical_corner(&self) -> PhysicalCorner

pub fn block_flow_direction(&self) -> BlockFlowDirection

pub fn inline_base_direction(&self) -> InlineBaseDirection

pub fn to_bidi_level(&self) -> Level

The default bidirectional embedding level for this writing mode.

Returns bidi level 0 if the mode is LTR, or 1 otherwise.

Trait Implementations

impl Binary for WritingMode

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

Formats the value using the given formatter.

impl BitAnd<WritingMode> for WritingMode

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

Returns the intersection between the two sets of flags.

type Output = WritingMode

The resulting type after applying the & operator.

impl BitAndAssign<WritingMode> for WritingMode

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<WritingMode> for WritingMode

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

Returns the union of the two sets of flags.

type Output = WritingMode

The resulting type after applying the | operator.

impl BitOrAssign<WritingMode> for WritingMode

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<WritingMode> for WritingMode

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

Returns the left flags, but with all the right flags toggled.

type Output = WritingMode

The resulting type after applying the ^ operator.

impl BitXorAssign<WritingMode> for WritingMode

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for WritingMode

fn clone(&self) -> WritingMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WritingMode

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

Formats the value using the given formatter.

impl Display for WritingMode

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

Formats the value using the given formatter.

impl Extend<WritingMode> for WritingMode

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

Extends a collection with the contents of an iterator.

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 FromIterator<WritingMode> for WritingMode

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

Creates a value from an iterator.

impl Hash for WritingMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for WritingMode

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

Formats the value using the given formatter.

impl MallocSizeOf for WritingMode

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 WritingMode

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = WritingMode

The resulting type after applying the ! operator.

impl Octal for WritingMode

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

Formats the value using the given formatter.

impl Ord for WritingMode

fn cmp(&self, other: &WritingMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<WritingMode> for WritingMode

fn eq(&self, other: &WritingMode) -> 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 PartialOrd<WritingMode> for WritingMode

fn partial_cmp(&self, other: &WritingMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for WritingMode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<WritingMode> for WritingMode

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

Returns the set difference of the two sets of flags.

type Output = WritingMode

The resulting type after applying the - operator.

impl SubAssign<WritingMode> for WritingMode

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for WritingMode

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

Formats the value using the given formatter.

impl __BitFlags for WritingMode

fn VERTICAL(&self) -> bool

fn INLINE_REVERSED(&self) -> bool

fn VERTICAL_LR(&self) -> bool

fn LINE_INVERTED(&self) -> bool

fn RTL(&self) -> bool

fn VERTICAL_SIDEWAYS(&self) -> bool

fn TEXT_SIDEWAYS(&self) -> bool

fn UPRIGHT(&self) -> bool

impl __BitFlags for WritingMode

const VERTICAL: u8 = 1u8

const INLINE_REVERSED: u8 = 2u8

const VERTICAL_LR: u8 = 4u8

const LINE_INVERTED: u8 = 8u8

const RTL: u8 = 16u8

const VERTICAL_SIDEWAYS: u8 = 32u8

const TEXT_SIDEWAYS: u8 = 64u8

const UPRIGHT: u8 = 128u8

impl Copy for WritingMode

impl Eq for WritingMode

impl StructuralEq for WritingMode

impl StructuralPartialEq for WritingMode