Skip to main content

Flags

Struct Flags 

Source
pub struct Flags(/* private fields */);
๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

Implementationsยง

Sourceยง

impl Flags

Source

pub const INTERPOLATE_COLORS_IN_PREMUL: Self

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module
Sourceยง

impl Flags

Source

pub const fn empty() -> Self

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

Get a flags value with all bits unset.

Source

pub const fn all() -> Self

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

Get a flags value with all known bits set.

Source

pub const fn bits(&self) -> u32

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

Get the underlying bits value.

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

Source

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

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

Convert from a bits value.

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

Source

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

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

Convert from a bits value, unsetting any unknown bits.

Source

pub const fn from_bits_retain(bits: u32) -> Self

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

Convert from a bits value exactly.

Source

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

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

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.

Source

pub const fn is_empty(&self) -> bool

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

Whether all bits in this flags value are unset.

Source

pub const fn is_all(&self) -> bool

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

Whether all known bits in this flags value are set.

Source

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

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

Whether any set bits in a source flags value are also set in a target flags value.

Source

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

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

Whether all set bits in a source flags value are also set in a target flags value.

Source

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

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

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

Source

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

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

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.

Source

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

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

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

Source

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

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

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

Source

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

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

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

Source

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

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

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

Source

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

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

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

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

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

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

Source

pub const fn complement(self) -> Self

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

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

Sourceยง

impl Flags

Source

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

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

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.

Source

pub const fn iter_names(&self) -> IterNames<Flags>

๐Ÿ‘ŽDeprecated since 0.94.0: Use the skia_safe::gradient module

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 Flags

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl BitAnd for Flags

Sourceยง

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

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

Sourceยง

type Output = Flags

The resulting type after applying the & operator.
Sourceยง

impl BitAndAssign for Flags

Sourceยง

fn bitand_assign(&mut self, other: Self)

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

Sourceยง

impl BitOr for Flags

Sourceยง

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

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

Sourceยง

type Output = Flags

The resulting type after applying the | operator.
Sourceยง

impl BitOrAssign for Flags

Sourceยง

fn bitor_assign(&mut self, other: Self)

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

Sourceยง

impl BitXor for Flags

Sourceยง

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

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

Sourceยง

type Output = Flags

The resulting type after applying the ^ operator.
Sourceยง

impl BitXorAssign for Flags

Sourceยง

fn bitxor_assign(&mut self, other: Self)

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

Sourceยง

impl Clone for Flags

Sourceยง

fn clone(&self) -> Flags

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
Sourceยง

impl Debug for Flags

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl Default for Flags

Sourceยง

fn default() -> Self

Returns the โ€œdefault valueโ€ for a type. Read more
Sourceยง

impl Extend<Flags> for Flags

Sourceยง

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)

๐Ÿ”ฌ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
Sourceยง

impl Flags for Flags

Sourceยง

const FLAGS: &'static [Flag<Flags>]

The set of defined flags.
Sourceยง

type Bits = u32

The underlying bits type.
Sourceยง

fn bits(&self) -> u32

Get the underlying bits value. Read more
Sourceยง

fn from_bits_retain(bits: u32) -> Flags

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 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 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 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 (&!). Read more
ยง

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 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 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 (&!). Read more
ยง

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.
Sourceยง

impl From<Flags> for Interpolation

Sourceยง

fn from(flags: Flags) -> Self

Converts to this type from the input type.
Sourceยง

impl FromIterator<Flags> for Flags

Sourceยง

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

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

Sourceยง

impl Hash for Flags

Sourceยง

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

Feeds this value into the given Hasher. Read more
1.3.0 ยท Sourceยง

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

Feeds a slice of this type into the given Hasher. Read more
Sourceยง

impl IntoIterator for Flags

Sourceยง

type Item = Flags

The type of the elements being iterated over.
Sourceยง

type IntoIter = Iter<Flags>

Which kind of iterator are we turning this into?
Sourceยง

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Sourceยง

impl LowerHex for Flags

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl Not for Flags

Sourceยง

fn not(self) -> Self

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

Sourceยง

type Output = Flags

The resulting type after applying the ! operator.
Sourceยง

impl Octal for Flags

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl Ord for Flags

Sourceยง

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

This method returns an Ordering between self and other. Read more
1.21.0 ยท Sourceยง

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

Compares and returns the maximum of two values. Read more
1.21.0 ยท Sourceยง

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

Compares and returns the minimum of two values. Read more
1.50.0 ยท Sourceยง

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Sourceยง

impl PartialEq for Flags

Sourceยง

fn eq(&self, other: &Flags) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 ยท Sourceยง

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Sourceยง

impl PartialOrd for Flags

Sourceยง

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 ยท Sourceยง

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 ยท Sourceยง

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 ยท Sourceยง

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 ยท Sourceยง

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Sourceยง

impl PublicFlags for Flags

Sourceยง

type Primitive = u32

The type of the underlying storage.
Sourceยง

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.
Sourceยง

impl Sub for Flags

Sourceยง

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.

Sourceยง

type Output = Flags

The resulting type after applying the - operator.
Sourceยง

impl SubAssign for Flags

Sourceยง

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 Flags

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl Copy for Flags

Sourceยง

impl Eq for Flags

Sourceยง

impl StructuralPartialEq for Flags

Auto Trait Implementationsยง

Blanket Implementationsยง

Sourceยง

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

Sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
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<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> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

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