Struct style::logical_geometry::WritingMode

#[repr(C)]
pub struct WritingMode(u8);

Tuple Fields

0: 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.

impl WritingMode

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) -> u8

Get the underlying bits value.

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

pub const fn from_bits(bits: u8) -> 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: u8) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u8) -> 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 WritingMode

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

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

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 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

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.

pub fn is_text_vertical(&self) -> bool

Is the text layout vertical?

Trait Implementations

impl Binary for WritingMode

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

Formats the value using the given formatter.

impl BitAnd for WritingMode

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

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

type Output = WritingMode

The resulting type after applying the & operator.

impl BitAndAssign for WritingMode

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for WritingMode

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

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

type Output = WritingMode

The resulting type after applying the | operator.

impl BitOrAssign for WritingMode

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for WritingMode

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

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

type Output = WritingMode

The resulting type after applying the ^ operator.

impl BitXorAssign for WritingMode

fn bitxor_assign(&mut self, other: Self)

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

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)

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 WritingMode

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

The set of defined flags.

type Bits = u8

The underlying bits type.

fn bits(&self) -> u8

Get the underlying bits value.

fn from_bits_retain(bits: u8) -> WritingMode

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

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

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

impl IntoIterator for WritingMode

type Item = WritingMode

The type of the elements being iterated over.

type IntoIter = Iter<WritingMode>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

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

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

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 = WritingMode

The resulting type after applying the - operator.

impl SubAssign for WritingMode

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 WritingMode

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

Formats the value using the given formatter.

impl Copy for WritingMode

impl Eq for WritingMode

impl StructuralPartialEq for WritingMode