Struct PagerOptions
pub struct PagerOptions(/* private fields */);
Expand description
Options that may be used when creating a pager.
Implementations§
§impl PagerOptions
impl PagerOptions
pub const fn empty() -> PagerOptions
pub const fn empty() -> PagerOptions
Get a flags value with all bits unset.
pub const fn all() -> PagerOptions
pub const fn all() -> PagerOptions
Get a flags value with all known bits set.
pub const fn bits(&self) -> u32
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<PagerOptions>
pub const fn from_bits(bits: u32) -> Option<PagerOptions>
Convert from a bits value.
This method will return None
if any unknown bits are set.
pub const fn from_bits_truncate(bits: u32) -> PagerOptions
pub const fn from_bits_truncate(bits: u32) -> PagerOptions
Convert from a bits value, unsetting any unknown bits.
pub const fn from_bits_retain(bits: u32) -> PagerOptions
pub const fn from_bits_retain(bits: u32) -> PagerOptions
Convert from a bits value exactly.
pub fn from_name(name: &str) -> Option<PagerOptions>
pub fn from_name(name: &str) -> Option<PagerOptions>
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 intersects(&self, other: PagerOptions) -> bool
pub const fn intersects(&self, other: PagerOptions) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
pub const fn contains(&self, other: PagerOptions) -> bool
pub const fn contains(&self, other: PagerOptions) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
pub fn insert(&mut self, other: PagerOptions)
pub fn insert(&mut self, other: PagerOptions)
The bitwise or (|
) of the bits in two flags values.
pub fn remove(&mut self, other: PagerOptions)
pub fn remove(&mut self, other: PagerOptions)
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.
pub fn toggle(&mut self, other: PagerOptions)
pub fn toggle(&mut self, other: PagerOptions)
The bitwise exclusive-or (^
) of the bits in two flags values.
pub fn set(&mut self, other: PagerOptions, value: bool)
pub fn set(&mut self, other: PagerOptions, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
pub const fn intersection(self, other: PagerOptions) -> PagerOptions
pub const fn intersection(self, other: PagerOptions) -> PagerOptions
The bitwise and (&
) of the bits in two flags values.
pub const fn union(self, other: PagerOptions) -> PagerOptions
pub const fn union(self, other: PagerOptions) -> PagerOptions
The bitwise or (|
) of the bits in two flags values.
pub const fn difference(self, other: PagerOptions) -> PagerOptions
pub const fn difference(self, other: PagerOptions) -> PagerOptions
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.
pub const fn symmetric_difference(self, other: PagerOptions) -> PagerOptions
pub const fn symmetric_difference(self, other: PagerOptions) -> PagerOptions
The bitwise exclusive-or (^
) of the bits in two flags values.
pub const fn complement(self) -> PagerOptions
pub const fn complement(self) -> PagerOptions
The bitwise negation (!
) of the bits in a flags value, truncating the result.
§impl PagerOptions
impl PagerOptions
pub const fn iter(&self) -> Iter<PagerOptions>
pub const fn iter(&self) -> Iter<PagerOptions>
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<PagerOptions>
pub const fn iter_names(&self) -> IterNames<PagerOptions>
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 PagerOptions
impl Binary for PagerOptions
§impl BitAnd for PagerOptions
impl BitAnd for PagerOptions
§fn bitand(self, other: PagerOptions) -> PagerOptions
fn bitand(self, other: PagerOptions) -> PagerOptions
The bitwise and (&
) of the bits in two flags values.
§type Output = PagerOptions
type Output = PagerOptions
&
operator.§impl BitAndAssign for PagerOptions
impl BitAndAssign for PagerOptions
§fn bitand_assign(&mut self, other: PagerOptions)
fn bitand_assign(&mut self, other: PagerOptions)
The bitwise and (&
) of the bits in two flags values.
§impl BitOr for PagerOptions
impl BitOr for PagerOptions
§fn bitor(self, other: PagerOptions) -> PagerOptions
fn bitor(self, other: PagerOptions) -> PagerOptions
The bitwise or (|
) of the bits in two flags values.
§type Output = PagerOptions
type Output = PagerOptions
|
operator.§impl BitOrAssign for PagerOptions
impl BitOrAssign for PagerOptions
§fn bitor_assign(&mut self, other: PagerOptions)
fn bitor_assign(&mut self, other: PagerOptions)
The bitwise or (|
) of the bits in two flags values.
§impl BitXor for PagerOptions
impl BitXor for PagerOptions
§fn bitxor(self, other: PagerOptions) -> PagerOptions
fn bitxor(self, other: PagerOptions) -> PagerOptions
The bitwise exclusive-or (^
) of the bits in two flags values.
§type Output = PagerOptions
type Output = PagerOptions
^
operator.§impl BitXorAssign for PagerOptions
impl BitXorAssign for PagerOptions
§fn bitxor_assign(&mut self, other: PagerOptions)
fn bitxor_assign(&mut self, other: PagerOptions)
The bitwise exclusive-or (^
) of the bits in two flags values.
§impl Clone for PagerOptions
impl Clone for PagerOptions
§fn clone(&self) -> PagerOptions
fn clone(&self) -> PagerOptions
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for PagerOptions
impl Debug for PagerOptions
§impl Extend<PagerOptions> for PagerOptions
impl Extend<PagerOptions> for PagerOptions
§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = PagerOptions>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = PagerOptions>,
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
)§impl Flags for PagerOptions
impl Flags for PagerOptions
§const FLAGS: &'static [Flag<PagerOptions>]
const FLAGS: &'static [Flag<PagerOptions>]
§fn from_bits_retain(bits: u32) -> PagerOptions
fn from_bits_retain(bits: u32) -> PagerOptions
§fn contains_unknown_bits(&self) -> bool
fn contains_unknown_bits(&self) -> bool
true
if any unknown bits are set.§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
§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.§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read more§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.§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where
Self: Sized,
Flags::insert
] when value
is true
or [Flags::remove
] when value
is false
.§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read more§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.§impl FromIterator<PagerOptions> for PagerOptions
impl FromIterator<PagerOptions> for PagerOptions
§fn from_iter<T>(iterator: T) -> PagerOptionswhere
T: IntoIterator<Item = PagerOptions>,
fn from_iter<T>(iterator: T) -> PagerOptionswhere
T: IntoIterator<Item = PagerOptions>,
The bitwise or (|
) of the bits in each flags value.
§impl Hash for PagerOptions
impl Hash for PagerOptions
§impl IntoIterator for PagerOptions
impl IntoIterator for PagerOptions
§type Item = PagerOptions
type Item = PagerOptions
§type IntoIter = Iter<PagerOptions>
type IntoIter = Iter<PagerOptions>
§fn into_iter(self) -> <PagerOptions as IntoIterator>::IntoIter
fn into_iter(self) -> <PagerOptions as IntoIterator>::IntoIter
§impl LowerHex for PagerOptions
impl LowerHex for PagerOptions
§impl Not for PagerOptions
impl Not for PagerOptions
§fn not(self) -> PagerOptions
fn not(self) -> PagerOptions
The bitwise negation (!
) of the bits in a flags value, truncating the result.
§type Output = PagerOptions
type Output = PagerOptions
!
operator.§impl Octal for PagerOptions
impl Octal for PagerOptions
§impl Ord for PagerOptions
impl Ord for PagerOptions
§impl PartialEq for PagerOptions
impl PartialEq for PagerOptions
§impl PartialOrd for PagerOptions
impl PartialOrd for PagerOptions
§impl Sub for PagerOptions
impl Sub for PagerOptions
§fn sub(self, other: PagerOptions) -> PagerOptions
fn sub(self, other: PagerOptions) -> PagerOptions
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 = PagerOptions
type Output = PagerOptions
-
operator.§impl SubAssign for PagerOptions
impl SubAssign for PagerOptions
§fn sub_assign(&mut self, other: PagerOptions)
fn sub_assign(&mut self, other: PagerOptions)
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.