Struct dom::DocumentState
source · #[repr(C)]pub struct DocumentState(pub(crate) <DocumentState as PublicFlags>::Internal);
Expand description
Event-based document states.
Tuple Fields§
§0: <DocumentState as PublicFlags>::Internal
Implementations§
source§impl DocumentState
impl DocumentState
sourcepub const WINDOW_INACTIVE: Self = _
pub const WINDOW_INACTIVE: Self = _
Window activation status
sourcepub const RTL_LOCALE: Self = _
pub const RTL_LOCALE: Self = _
RTL locale: specific to the XUL localedir attribute
sourcepub const LTR_LOCALE: Self = _
pub const LTR_LOCALE: Self = _
LTR locale: specific to the XUL localedir attribute
pub const ALL_LOCALEDIR_BITS: Self = _
source§impl DocumentState
impl DocumentState
sourcepub const fn bits(&self) -> u64
pub const fn bits(&self) -> u64
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u64) -> Option<Self>
pub const fn from_bits(bits: u64) -> 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: u64) -> Self
pub const fn from_bits_truncate(bits: u64) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u64) -> Self
pub const fn from_bits_retain(bits: u64) -> 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 DocumentState
impl DocumentState
sourcepub const fn iter(&self) -> Iter<DocumentState>
pub const fn iter(&self) -> Iter<DocumentState>
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<DocumentState>
pub const fn iter_names(&self) -> IterNames<DocumentState>
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 DocumentState
impl Binary for DocumentState
source§impl BitAnd for DocumentState
impl BitAnd for DocumentState
source§impl BitAndAssign for DocumentState
impl BitAndAssign for DocumentState
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 DocumentState
impl BitOr for DocumentState
source§fn bitor(self, other: DocumentState) -> Self
fn bitor(self, other: DocumentState) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = DocumentState
type Output = DocumentState
|
operator.source§impl BitOrAssign for DocumentState
impl BitOrAssign for DocumentState
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 DocumentState
impl BitXor for DocumentState
source§impl BitXorAssign for DocumentState
impl BitXorAssign for DocumentState
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 DocumentState
impl Clone for DocumentState
source§fn clone(&self) -> DocumentState
fn clone(&self) -> DocumentState
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DocumentState
impl Debug for DocumentState
source§impl Extend<DocumentState> for DocumentState
impl Extend<DocumentState> for DocumentState
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 DocumentState
impl Flags for DocumentState
source§const FLAGS: &'static [Flag<DocumentState>] = _
const FLAGS: &'static [Flag<DocumentState>] = _
source§fn from_bits_retain(bits: u64) -> DocumentState
fn from_bits_retain(bits: u64) -> DocumentState
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<DocumentState> for DocumentState
impl FromIterator<DocumentState> for DocumentState
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 IntoIterator for DocumentState
impl IntoIterator for DocumentState
source§impl LowerHex for DocumentState
impl LowerHex for DocumentState
source§impl Not for DocumentState
impl Not for DocumentState
source§impl Octal for DocumentState
impl Octal for DocumentState
source§impl PartialEq for DocumentState
impl PartialEq for DocumentState
source§fn eq(&self, other: &DocumentState) -> bool
fn eq(&self, other: &DocumentState) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for DocumentState
impl PublicFlags for DocumentState
source§impl Sub for DocumentState
impl Sub for DocumentState
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 = DocumentState
type Output = DocumentState
-
operator.source§impl SubAssign for DocumentState
impl SubAssign for DocumentState
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.