Struct fonts::font::ShapingFlags
source · pub struct ShapingFlags(<ShapingFlags as PublicFlags>::Internal);
Tuple Fields§
§0: <ShapingFlags as PublicFlags>::Internal
Implementations§
source§impl ShapingFlags
impl ShapingFlags
sourcepub const IS_WHITESPACE_SHAPING_FLAG: Self = _
pub const IS_WHITESPACE_SHAPING_FLAG: Self = _
Set if the text is entirely whitespace.
sourcepub const ENDS_WITH_WHITESPACE_SHAPING_FLAG: Self = _
pub const ENDS_WITH_WHITESPACE_SHAPING_FLAG: Self = _
Set if the text ends with whitespace.
sourcepub const IGNORE_LIGATURES_SHAPING_FLAG: Self = _
pub const IGNORE_LIGATURES_SHAPING_FLAG: Self = _
Set if we are to ignore ligatures.
sourcepub const DISABLE_KERNING_SHAPING_FLAG: Self = _
pub const DISABLE_KERNING_SHAPING_FLAG: Self = _
Set if we are to disable kerning.
sourcepub const KEEP_ALL_FLAG: Self = _
pub const KEEP_ALL_FLAG: Self = _
Set if word-break is set to keep-all.
source§impl ShapingFlags
impl ShapingFlags
sourcepub const fn bits(&self) -> u8
pub const fn bits(&self) -> u8
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u8) -> Option<Self>
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.
sourcepub const fn from_bits_truncate(bits: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u8) -> Self
pub const fn from_bits_retain(bits: u8) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
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.
sourcepub const fn intersects(&self, other: Self) -> bool
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.
sourcepub const fn contains(&self, other: Self) -> bool
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.
sourcepub fn remove(&mut self, other: Self)
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.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
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.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl ShapingFlags
impl ShapingFlags
sourcepub const fn iter(&self) -> Iter<ShapingFlags>
pub const fn iter(&self) -> Iter<ShapingFlags>
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.
sourcepub const fn iter_names(&self) -> IterNames<ShapingFlags>
pub const fn iter_names(&self) -> IterNames<ShapingFlags>
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.
Trait Implementations§
source§impl Binary for ShapingFlags
impl Binary for ShapingFlags
source§impl BitAnd for ShapingFlags
impl BitAnd for ShapingFlags
source§impl BitAndAssign for ShapingFlags
impl BitAndAssign for ShapingFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for ShapingFlags
impl BitOr for ShapingFlags
source§fn bitor(self, other: ShapingFlags) -> Self
fn bitor(self, other: ShapingFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = ShapingFlags
type Output = ShapingFlags
|
operator.source§impl BitOrAssign for ShapingFlags
impl BitOrAssign for ShapingFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for ShapingFlags
impl BitXor for ShapingFlags
source§impl BitXorAssign for ShapingFlags
impl BitXorAssign for ShapingFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for ShapingFlags
impl Clone for ShapingFlags
source§fn clone(&self) -> ShapingFlags
fn clone(&self) -> ShapingFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ShapingFlags
impl Debug for ShapingFlags
source§impl Extend<ShapingFlags> for ShapingFlags
impl Extend<ShapingFlags> for ShapingFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for ShapingFlags
impl Flags for ShapingFlags
source§const FLAGS: &'static [Flag<ShapingFlags>] = _
const FLAGS: &'static [Flag<ShapingFlags>] = _
source§fn from_bits_retain(bits: u8) -> ShapingFlags
fn from_bits_retain(bits: u8) -> ShapingFlags
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<ShapingFlags> for ShapingFlags
impl FromIterator<ShapingFlags> for ShapingFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for ShapingFlags
impl Hash for ShapingFlags
source§impl IntoIterator for ShapingFlags
impl IntoIterator for ShapingFlags
source§impl LowerHex for ShapingFlags
impl LowerHex for ShapingFlags
source§impl Not for ShapingFlags
impl Not for ShapingFlags
source§impl Octal for ShapingFlags
impl Octal for ShapingFlags
source§impl PartialEq for ShapingFlags
impl PartialEq for ShapingFlags
source§fn eq(&self, other: &ShapingFlags) -> bool
fn eq(&self, other: &ShapingFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for ShapingFlags
impl PublicFlags for ShapingFlags
source§impl Sub for ShapingFlags
impl Sub for ShapingFlags
source§fn sub(self, other: Self) -> Self
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 = ShapingFlags
type Output = ShapingFlags
-
operator.source§impl SubAssign for ShapingFlags
impl SubAssign for ShapingFlags
source§fn sub_assign(&mut self, other: Self)
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.
source§impl UpperHex for ShapingFlags
impl UpperHex for ShapingFlags
impl Copy for ShapingFlags
impl Eq for ShapingFlags
impl StructuralPartialEq for ShapingFlags
Auto Trait Implementations§
impl Freeze for ShapingFlags
impl RefUnwindSafe for ShapingFlags
impl Send for ShapingFlags
impl Sync for ShapingFlags
impl Unpin for ShapingFlags
impl UnwindSafe for ShapingFlags
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more