Struct atk::HyperlinkStateFlags
source · [−]pub struct HyperlinkStateFlags { /* private fields */ }
Expand description
Describes the type of link
Implementations
sourceimpl HyperlinkStateFlags
impl HyperlinkStateFlags
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
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
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
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
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
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
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
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
sourceimpl Binary for HyperlinkStateFlags
impl Binary for HyperlinkStateFlags
sourceimpl BitAnd<HyperlinkStateFlags> for HyperlinkStateFlags
impl BitAnd<HyperlinkStateFlags> for HyperlinkStateFlags
type Output = HyperlinkStateFlags
type Output = HyperlinkStateFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<HyperlinkStateFlags> for HyperlinkStateFlags
impl BitAndAssign<HyperlinkStateFlags> for HyperlinkStateFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<HyperlinkStateFlags> for HyperlinkStateFlags
impl BitOr<HyperlinkStateFlags> for HyperlinkStateFlags
sourcefn bitor(self, other: HyperlinkStateFlags) -> Self
fn bitor(self, other: HyperlinkStateFlags) -> Self
Returns the union of the two sets of flags.
type Output = HyperlinkStateFlags
type Output = HyperlinkStateFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<HyperlinkStateFlags> for HyperlinkStateFlags
impl BitOrAssign<HyperlinkStateFlags> for HyperlinkStateFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<HyperlinkStateFlags> for HyperlinkStateFlags
impl BitXor<HyperlinkStateFlags> for HyperlinkStateFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = HyperlinkStateFlags
type Output = HyperlinkStateFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<HyperlinkStateFlags> for HyperlinkStateFlags
impl BitXorAssign<HyperlinkStateFlags> for HyperlinkStateFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for HyperlinkStateFlags
impl Clone for HyperlinkStateFlags
sourcefn clone(&self) -> HyperlinkStateFlags
fn clone(&self) -> HyperlinkStateFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for HyperlinkStateFlags
impl Debug for HyperlinkStateFlags
sourceimpl Display for HyperlinkStateFlags
impl Display for HyperlinkStateFlags
sourceimpl Extend<HyperlinkStateFlags> for HyperlinkStateFlags
impl Extend<HyperlinkStateFlags> for HyperlinkStateFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<HyperlinkStateFlags> for HyperlinkStateFlags
impl FromIterator<HyperlinkStateFlags> for HyperlinkStateFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl<'a> FromValue<'a> for HyperlinkStateFlags
impl<'a> FromValue<'a> for HyperlinkStateFlags
type Checker = GenericValueTypeChecker<HyperlinkStateFlags>
type Checker = GenericValueTypeChecker<HyperlinkStateFlags>
Value type checker.
sourceunsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Get the contained value from a Value
. Read more
sourceimpl Hash for HyperlinkStateFlags
impl Hash for HyperlinkStateFlags
sourceimpl LowerHex for HyperlinkStateFlags
impl LowerHex for HyperlinkStateFlags
sourceimpl Not for HyperlinkStateFlags
impl Not for HyperlinkStateFlags
type Output = HyperlinkStateFlags
type Output = HyperlinkStateFlags
The resulting type after applying the !
operator.
sourceimpl Octal for HyperlinkStateFlags
impl Octal for HyperlinkStateFlags
sourceimpl Ord for HyperlinkStateFlags
impl Ord for HyperlinkStateFlags
sourceimpl PartialEq<HyperlinkStateFlags> for HyperlinkStateFlags
impl PartialEq<HyperlinkStateFlags> for HyperlinkStateFlags
sourcefn eq(&self, other: &HyperlinkStateFlags) -> bool
fn eq(&self, other: &HyperlinkStateFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &HyperlinkStateFlags) -> bool
fn ne(&self, other: &HyperlinkStateFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<HyperlinkStateFlags> for HyperlinkStateFlags
impl PartialOrd<HyperlinkStateFlags> for HyperlinkStateFlags
sourcefn partial_cmp(&self, other: &HyperlinkStateFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &HyperlinkStateFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl StaticType for HyperlinkStateFlags
impl StaticType for HyperlinkStateFlags
sourcefn static_type() -> Type
fn static_type() -> Type
Returns the type identifier of Self
.
sourceimpl Sub<HyperlinkStateFlags> for HyperlinkStateFlags
impl Sub<HyperlinkStateFlags> for HyperlinkStateFlags
type Output = HyperlinkStateFlags
type Output = HyperlinkStateFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<HyperlinkStateFlags> for HyperlinkStateFlags
impl SubAssign<HyperlinkStateFlags> for HyperlinkStateFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl ToValue for HyperlinkStateFlags
impl ToValue for HyperlinkStateFlags
sourceimpl UpperHex for HyperlinkStateFlags
impl UpperHex for HyperlinkStateFlags
sourceimpl ValueType for HyperlinkStateFlags
impl ValueType for HyperlinkStateFlags
type Type = HyperlinkStateFlags
type Type = HyperlinkStateFlags
Type to get the Type
from. Read more
impl Copy for HyperlinkStateFlags
impl Eq for HyperlinkStateFlags
impl StructuralEq for HyperlinkStateFlags
impl StructuralPartialEq for HyperlinkStateFlags
Auto Trait Implementations
impl RefUnwindSafe for HyperlinkStateFlags
impl Send for HyperlinkStateFlags
impl Sync for HyperlinkStateFlags
impl Unpin for HyperlinkStateFlags
impl UnwindSafe for HyperlinkStateFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> StaticTypeExt for T where
T: StaticType,
impl<T> StaticTypeExt for T where
T: StaticType,
sourcefn ensure_type()
fn ensure_type()
Ensures that the type has been registered with the type system.
sourceimpl<T> ToClosureReturnValue for T where
T: ToValue,
impl<T> ToClosureReturnValue for T where
T: ToValue,
fn to_closure_return_value(&self) -> Option<Value>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> ToSendValue for T where
T: Send + ToValue + ?Sized,
impl<T> ToSendValue for T where
T: Send + ToValue + ?Sized,
sourcefn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
Returns a SendValue
clone of self
.