Struct write_fonts::tables::stat::AxisValueTableFlags

pub struct AxisValueTableFlags { /* private fields */ }

Axis value table flags.

Implementations

impl AxisValueTableFlags

pub const OLDER_SIBLING_FONT_ATTRIBUTE: AxisValueTableFlags = Self{ bits: 1,}

If set, this axis value table provides axis value information that is applicable to other fonts within the same font family. This is used if the other fonts were released earlier and did not include information about values for some axis. If newer versions of the other fonts include the information themselves and are present, then this table is ignored.

pub const ELIDABLE_AXIS_VALUE_NAME: AxisValueTableFlags = Self{ bits: 2,}

If set, it indicates that the axis value represents the “normal” value for the axis and may be omitted when composing name strings.

pub const fn empty() -> AxisValueTableFlags

Returns an empty set of flags.

pub const fn all() -> AxisValueTableFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u16

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u16) -> Option<AxisValueTableFlags>

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

pub const fn from_bits_truncate(bits: u16) -> AxisValueTableFlags

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

pub const unsafe fn from_bits_unchecked(bits: u16) -> AxisValueTableFlags

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: AxisValueTableFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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

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: AxisValueTableFlags) -> AxisValueTableFlags

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: AxisValueTableFlags) -> AxisValueTableFlags

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: AxisValueTableFlags
) -> AxisValueTableFlags

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

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.

Trait Implementations

impl Binary for AxisValueTableFlags

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

Formats the value using the given formatter.

impl BitAnd<AxisValueTableFlags> for AxisValueTableFlags

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

Returns the intersection between the two sets of flags.

type Output = AxisValueTableFlags

The resulting type after applying the & operator.

impl BitAndAssign<AxisValueTableFlags> for AxisValueTableFlags

fn bitand_assign(&mut self, other: AxisValueTableFlags)

Disables all flags disabled in the set.

impl BitOr<AxisValueTableFlags> for AxisValueTableFlags

fn bitor(self, other: AxisValueTableFlags) -> AxisValueTableFlags

Returns the union of the two sets of flags.

type Output = AxisValueTableFlags

The resulting type after applying the | operator.

impl BitOrAssign<AxisValueTableFlags> for AxisValueTableFlags

fn bitor_assign(&mut self, other: AxisValueTableFlags)

Adds the set of flags.

impl BitXor<AxisValueTableFlags> for AxisValueTableFlags

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

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

type Output = AxisValueTableFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<AxisValueTableFlags> for AxisValueTableFlags

fn bitxor_assign(&mut self, other: AxisValueTableFlags)

Toggles the set of flags.

impl Clone for AxisValueTableFlags

fn clone(&self) -> AxisValueTableFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AxisValueTableFlags

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

Formats the value using the given formatter.

impl Default for AxisValueTableFlags

fn default() -> AxisValueTableFlags

Returns the “default value” for a type.

impl Extend<AxisValueTableFlags> for AxisValueTableFlags

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

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 FontWrite for AxisValueTableFlags

fn write_into(&self, writer: &mut TableWriter)

Write our data and information about offsets into this TableWriter.

impl FromIterator<AxisValueTableFlags> for AxisValueTableFlags

fn from_iter<T>(iterator: T) -> AxisValueTableFlagswhere
    T: IntoIterator<Item = AxisValueTableFlags>,

Creates a value from an iterator.

impl Hash for AxisValueTableFlags

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

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 AxisValueTableFlags

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

Formats the value using the given formatter.

impl Not for AxisValueTableFlags

fn not(self) -> AxisValueTableFlags

Returns the complement of this set of flags.

type Output = AxisValueTableFlags

The resulting type after applying the ! operator.

impl Octal for AxisValueTableFlags

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

Formats the value using the given formatter.

impl Ord for AxisValueTableFlags

fn cmp(&self, other: &AxisValueTableFlags) -> 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<AxisValueTableFlags> for AxisValueTableFlags

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

fn partial_cmp(&self, other: &AxisValueTableFlags) -> 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 Scalar for AxisValueTableFlags

type Raw = <u16 as Scalar>::Raw

The raw byte representation of this type.

fn to_raw(self) -> <AxisValueTableFlags as Scalar>::Raw

Encode this type as raw big-endian bytes

fn from_raw(raw: <AxisValueTableFlags as Scalar>::Raw) -> AxisValueTableFlags

Create an instance of this type from raw big-endian bytes

impl Sub<AxisValueTableFlags> for AxisValueTableFlags

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

Returns the set difference of the two sets of flags.

type Output = AxisValueTableFlags

The resulting type after applying the - operator.

impl SubAssign<AxisValueTableFlags> for AxisValueTableFlags

fn sub_assign(&mut self, other: AxisValueTableFlags)

Disables all flags enabled in the set.

impl UpperHex for AxisValueTableFlags

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

Formats the value using the given formatter.

impl Copy for AxisValueTableFlags

impl Eq for AxisValueTableFlags

impl StructuralEq for AxisValueTableFlags

impl StructuralPartialEq for AxisValueTableFlags