# Struct BufferFlags

    pub struct BufferFlags(/* private fields */);

Expand description

Flags for buffers.

## Implementations§

§

### impl BufferFlags

#### pub const BEGINNING_OF_TEXT: BufferFlags

Indicates that special handling of the beginning of text paragraph can be applied to this buffer. Should usually be set, unless you are passing to the buffer only part of the text without the full context.

#### pub const END_OF_TEXT: BufferFlags

Indicates that special handling of the end of text paragraph can be applied to this buffer, similar to `BufferFlags::BEGINNING_OF_TEXT`.

#### pub const PRESERVE_DEFAULT_IGNORABLES: BufferFlags

Indicates that characters with `Default_Ignorable` Unicode property should use the corresponding glyph from the font, instead of hiding them (done by replacing them with the space glyph and zeroing the advance width.) This flag takes precedence over `BufferFlags::REMOVE_DEFAULT_IGNORABLES`.

#### pub const REMOVE_DEFAULT_IGNORABLES: BufferFlags

Indicates that characters with `Default_Ignorable` Unicode property should be removed from glyph string instead of hiding them (done by replacing them with the space glyph and zeroing the advance width.) `BufferFlags::PRESERVE_DEFAULT_IGNORABLES` takes precedence over this flag.

#### pub const DO_NOT_INSERT_DOTTED_CIRCLE: BufferFlags

Indicates that a dotted circle should not be inserted in the rendering of incorrect character sequences (such as `<0905 093E>`).

#### pub const VERIFY: BufferFlags

Indicates that the shape() call and its variants should perform various verification processes on the results of the shaping operation on the buffer. If the verification fails, then either a buffer message is sent, if a message handler is installed on the buffer, or a message is written to standard error. In either case, the shaping result might be modified to show the failed output.

#### pub const PRODUCE_UNSAFE_TO_CONCAT: BufferFlags

Indicates that the `UNSAFE_TO_CONCAT` glyph-flag should be produced by the shaper. By default it will not be produced since it incurs a cost.

#### pub const PRODUCE_SAFE_TO_INSERT_TATWEEL: BufferFlags

Indicates that the `SAFE_TO_INSERT_TATWEEL` glyph-flag should be produced by the shaper. By default it will not be produced.

#### pub const DEFINED: BufferFlags

All currently defined flags

§

### impl BufferFlags

#### pub const fn empty() -> BufferFlags

Get a flags value with all bits unset.

#### pub const fn all() -> BufferFlags

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

Convert from a bits value.

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

#### pub const fn from_bits_truncate(bits: u32) -> BufferFlags

Convert from a bits value, unsetting any unknown bits.

#### pub const fn from_bits_retain(bits: u32) -> BufferFlags

Convert from a bits value exactly.

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

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 `self` 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: BufferFlags) -> bool

Whether any set bits in `other` are also set in `self`.

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

Whether all set bits in `other` are also set in `self`.

#### pub fn insert(&mut self, other: BufferFlags)

The bitwise or (`|`) of the bits in `self` and `other`.

#### pub fn remove(&mut self, other: BufferFlags)

The intersection of `self` with the complement of `other` (`&!`).

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

The bitwise exclusive-or (`^`) of the bits in `self` and `other`.

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

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

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

The bitwise and (`&`) of the bits in `self` and `other`.

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

The bitwise or (`|`) of the bits in `self` and `other`.

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

The intersection of `self` with the complement of `other` (`&!`).

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

The bitwise exclusive-or (`^`) of the bits in `self` and `other`.

#### pub const fn complement(self) -> BufferFlags

The bitwise negation (`!`) of the bits in `self`, truncating the result.

§

### impl BufferFlags

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

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

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§

§

### impl Binary for BufferFlags

§

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

Formats the value using the given formatter. Read more
§

### impl BitAnd for BufferFlags

§

#### fn bitand(self, other: BufferFlags) -> BufferFlags

The bitwise and (`&`) of the bits in `self` and `other`.

§

#### type Output = BufferFlags

The resulting type after applying the `&` operator.
§

### impl BitAndAssign for BufferFlags

§

#### fn bitand_assign(&mut self, other: BufferFlags)

The bitwise and (`&`) of the bits in `self` and `other`.

§

### impl BitOr for BufferFlags

§

#### fn bitor(self, other: BufferFlags) -> BufferFlags

The bitwise or (`|`) of the bits in `self` and `other`.

§

#### type Output = BufferFlags

The resulting type after applying the `|` operator.
§

### impl BitOrAssign for BufferFlags

§

#### fn bitor_assign(&mut self, other: BufferFlags)

The bitwise or (`|`) of the bits in `self` and `other`.

§

### impl BitXor for BufferFlags

§

#### fn bitxor(self, other: BufferFlags) -> BufferFlags

The bitwise exclusive-or (`^`) of the bits in `self` and `other`.

§

#### type Output = BufferFlags

The resulting type after applying the `^` operator.
§

### impl BitXorAssign for BufferFlags

§

#### fn bitxor_assign(&mut self, other: BufferFlags)

The bitwise exclusive-or (`^`) of the bits in `self` and `other`.

§

### impl Clone for BufferFlags

§

#### fn clone(&self) -> BufferFlags

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
§

### impl Debug for BufferFlags

§

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

Formats the value using the given formatter. Read more
§

### impl Default for BufferFlags

§

#### fn default() -> BufferFlags

Returns the “default value” for a type. Read more
§

### impl Extend<BufferFlags> for BufferFlags

§

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

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

Source§

#### fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (`extend_one`)
Extends a collection with exactly one element.
Source§

#### 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. Read more
§

### impl Flags for BufferFlags

§

#### const FLAGS: &'static [Flag<BufferFlags>]

The set of defined flags.
§

#### type Bits = u32

The underlying bits type.
§

#### fn bits(&self) -> u32

Get the underlying bits value. Read more
§

#### fn from_bits_retain(bits: u32) -> BufferFlags

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 known_bits(&self) -> Self::Bits

Get the known bits from a flags value.
§

#### fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.
§

#### fn contains_unknown_bits(&self) -> bool

This method will return `true` if any unknown bits are set.
§

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

Convert from a bits value. Read more
§

#### 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. Read more
§

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

Yield a set of contained flags values. Read more
§

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

Yield a set of contained named flags values. Read more
§

#### fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by [`Self::FLAGS`].
§

#### 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 `other` are also set in `self`.
§

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

Whether all set bits in `other` are also set in `self`.
§

#### fn truncate(&mut self)
where Self: Sized,

Remove any unknown bits from the flags.
§

#### fn insert(&mut self, other: Self)
where Self: Sized,

The bitwise or (`|`) of the bits in `self` and `other`.
§

#### fn remove(&mut self, other: Self)
where Self: Sized,

The intersection of `self` with the complement of `other` (`&!`). Read more
§

#### fn toggle(&mut self, other: Self)
where Self: Sized,

The bitwise exclusive-or (`^`) of the bits in `self` and `other`.
§

#### 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 clear(&mut self)
where Self: Sized,

Unsets all bits in the flags.
§

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

The bitwise and (`&`) of the bits in `self` and `other`.
§

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

The bitwise or (`|`) of the bits in `self` and `other`.
§

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

The intersection of `self` with the complement of `other` (`&!`). Read more
§

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

The bitwise exclusive-or (`^`) of the bits in `self` and `other`.
§

#### fn complement(self) -> Self

The bitwise negation (`!`) of the bits in `self`, truncating the result.
§

### impl FromIterator<BufferFlags> for BufferFlags

§

#### fn from_iter<T>(iterator: T) -> BufferFlags
where T: IntoIterator<Item = BufferFlags>,

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

§

### impl IntoIterator for BufferFlags

§

#### type Item = BufferFlags

The type of the elements being iterated over.
§

#### type IntoIter = Iter<BufferFlags>

Which kind of iterator are we turning this into?
§

#### fn into_iter(self) -> <BufferFlags as IntoIterator>::IntoIter

Creates an iterator from a value. Read more
§

### impl LowerHex for BufferFlags

§

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

Formats the value using the given formatter. Read more
§

### impl Not for BufferFlags

§

#### fn not(self) -> BufferFlags

The bitwise negation (`!`) of the bits in `self`, truncating the result.

§

#### type Output = BufferFlags

The resulting type after applying the `!` operator.
§

### impl Octal for BufferFlags

§

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

Formats the value using the given formatter. Read more
§

### impl Sub for BufferFlags

§

#### fn sub(self, other: BufferFlags) -> BufferFlags

The intersection of `self` with the complement of `other` (`&!`).

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

The resulting type after applying the `-` operator.
§

### impl SubAssign for BufferFlags

§

#### fn sub_assign(&mut self, other: BufferFlags)

The intersection of `self` with the complement of `other` (`&!`).

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 BufferFlags

§

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

Formats the value using the given formatter. Read more
§

### impl Copy for BufferFlags

## Auto Trait Implementations§

§

### impl Freeze for BufferFlags

§

### impl RefUnwindSafe for BufferFlags

§

### impl Send for BufferFlags

§

### impl Sync for BufferFlags

§

### impl Unpin for BufferFlags

§

### impl UnwindSafe for BufferFlags

## Blanket Implementations§

Source§

### impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

Source§

#### fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
Source§

#### fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
§

### impl<T> Also for T

§

#### fn also<F>(self, block: F) -> Self
where F: FnOnce(&mut Self),

Apply a function to this value and return the (possibly) modified value.
Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
§

### impl<T, Res> Apply<Res> for T
where T: ?Sized,

§

#### fn apply<F>(self, f: F) -> Res
where F: FnOnce(Self) -> Res, Self: Sized,

Apply a function which takes the parameter by value.
§

#### fn apply_ref<F>(&self, f: F) -> Res
where F: FnOnce(&Self) -> Res,

Apply a function which takes the parameter by reference.
§

#### fn apply_mut<F>(&mut self, f: F) -> Res
where F: FnOnce(&mut Self) -> Res,

Apply a function which takes the parameter by mutable reference.
Source§

### impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

Source§

#### fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
Source§

### impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

Source§

#### fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

Source§

#### type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in `parameters` when converting.
Source§

#### fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts `self` into `C`, using the provided parameters.
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

Source§

#### fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
§

### impl<T> Downcast for T
where T: Any,

§

#### fn into_any(self: Box<T>) -> Box<dyn Any>

Convert `Box<dyn Trait>` (where `Trait: Downcast`) to `Box<dyn Any>`. `Box<dyn Any>` can then be further `downcast` into `Box<ConcreteType>` where `ConcreteType` implements `Trait`.
§

#### fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert `Rc<Trait>` (where `Trait: Downcast`) to `Rc<Any>`. `Rc<Any>` can then be further `downcast` into `Rc<ConcreteType>` where `ConcreteType` implements `Trait`.
§

#### fn as_any(&self) -> &(dyn Any + 'static)

Convert `&Trait` (where `Trait: Downcast`) to `&Any`. This is needed since Rust cannot generate `&Any`’s vtable from `&Trait`’s.
§

#### fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert `&mut Trait` (where `Trait: Downcast`) to `&Any`. This is needed since Rust cannot generate `&mut Any`’s vtable from `&mut Trait`’s.
§

### impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

#### fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert `Arc<Trait>` (where `Trait: Downcast`) to `Arc<Any>`. `Arc<Any>` can then be further `downcast` into `Arc<ConcreteType>` where `ConcreteType` implements `Trait`.
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T> FromAngle<T> for T

Source§

#### fn from_angle(angle: T) -> T

Performs a conversion from `angle`.
Source§

### impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

Source§

#### fn from_stimulus(other: U) -> T

Converts `other` into `Self`, while performing the appropriate scaling, rounding and clamping.
§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T, U> IntoAngle<U> for T
where U: FromAngle<T>,

Source§

#### fn into_angle(self) -> U

Performs a conversion into `T`.
§

### impl<State, Message> IntoBoot<State, Message> for State

§

#### fn into_boot(self) -> (State, Task<Message>)

Turns some type into the initial state of some `Application`.
Source§

### impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

Source§

#### type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in `parameters` when converting.
Source§

#### fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts `self` into `C`, using the provided parameters.
Source§

### impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

#### fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
Source§

### impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

Source§

#### fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
Source§

### impl<T> IntoStimulus<T> for T

Source§

#### fn into_stimulus(self) -> T

Converts `self` into `T`, while performing the appropriate scaling, rounding and clamping.
§

### impl<T> NoneValue for T
where T: Default,

§

#### type NoneType = T

§

#### fn null_value() -> T

The none-equivalent value.
Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

Source§

#### type Error = <C as TryFromComponents<T>>::Error

The error for when `try_into_colors` fails to cast.
Source§

#### fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

Source§

#### fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an `OutOfBounds` error is returned which contains the unclamped color. Read more
Source§

### impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

Source§

#### fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
Source§

### impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

Source§

#### fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

### impl<T> MaybeClone for T

§

### impl<T> MaybeDebug for T

§

### impl<T> MaybeSend for T
where T: Send,

§

### impl<T> MaybeSend for T
where T: Send,

§

### impl<T> MaybeSync for T
where T: Sync,

§

### impl<T> MaybeSync for T
where T: Sync,