Struct pdf::parser::ParseFlags
source · pub struct ParseFlags { /* private fields */ }
Implementations§
source§impl ParseFlags
impl ParseFlags
pub const INTEGER: Self = _
pub const STREAM: Self = _
pub const DICT: Self = _
pub const NUMBER: Self = _
pub const NAME: Self = _
pub const ARRAY: Self = _
pub const STRING: Self = _
pub const BOOL: Self = _
pub const NULL: Self = _
pub const REF: Self = _
pub const ANY: Self = _
sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> 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: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u16) -> Self
pub const unsafe fn from_bits_unchecked(bits: u16) -> 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§
source§impl Binary for ParseFlags
impl Binary for ParseFlags
source§impl BitAnd for ParseFlags
impl BitAnd for ParseFlags
source§impl BitAndAssign for ParseFlags
impl BitAndAssign for ParseFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr for ParseFlags
impl BitOr for ParseFlags
source§fn bitor(self, other: ParseFlags) -> Self
fn bitor(self, other: ParseFlags) -> Self
Returns the union of the two sets of flags.
§type Output = ParseFlags
type Output = ParseFlags
|
operator.source§impl BitOrAssign for ParseFlags
impl BitOrAssign for ParseFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for ParseFlags
impl BitXor for ParseFlags
source§impl BitXorAssign for ParseFlags
impl BitXorAssign for ParseFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for ParseFlags
impl Clone for ParseFlags
source§fn clone(&self) -> ParseFlags
fn clone(&self) -> ParseFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ParseFlags
impl Debug for ParseFlags
source§impl Extend<ParseFlags> for ParseFlags
impl Extend<ParseFlags> for ParseFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 FromIterator<ParseFlags> for ParseFlags
impl FromIterator<ParseFlags> for ParseFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for ParseFlags
impl Hash for ParseFlags
source§impl LowerHex for ParseFlags
impl LowerHex for ParseFlags
source§impl Not for ParseFlags
impl Not for ParseFlags
source§impl Octal for ParseFlags
impl Octal for ParseFlags
source§impl Ord for ParseFlags
impl Ord for ParseFlags
source§fn cmp(&self, other: &ParseFlags) -> Ordering
fn cmp(&self, other: &ParseFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq for ParseFlags
impl PartialEq for ParseFlags
source§fn eq(&self, other: &ParseFlags) -> bool
fn eq(&self, other: &ParseFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for ParseFlags
impl PartialOrd for ParseFlags
source§fn partial_cmp(&self, other: &ParseFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &ParseFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub for ParseFlags
impl Sub for ParseFlags
source§impl SubAssign for ParseFlags
impl SubAssign for ParseFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl UpperHex for ParseFlags
impl UpperHex for ParseFlags
impl Copy for ParseFlags
impl Eq for ParseFlags
impl StructuralEq for ParseFlags
impl StructuralPartialEq for ParseFlags
Auto Trait Implementations§
impl RefUnwindSafe for ParseFlags
impl Send for ParseFlags
impl Sync for ParseFlags
impl Unpin for ParseFlags
impl UnwindSafe for ParseFlags
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.