Struct xmp_toolkit::OpenFileOptions
source · [−]pub struct OpenFileOptions { /* private fields */ }
Expand description
Option flags for XMPFile::open_file()
.
Flags describing the set of modules to load.
Implementations
sourceimpl OpenFileOptions
impl OpenFileOptions
sourcepub const OPEN_FOR_READ: Self = Self{bits: 1,}
pub const OPEN_FOR_READ: Self = Self{bits: 1,}
Open for read-only access.
sourcepub const OPEN_FOR_UPDATE: Self = Self{bits: 2,}
pub const OPEN_FOR_UPDATE: Self = Self{bits: 2,}
Open for reading and writing.
sourcepub const OPEN_ONLY_XMP: Self = Self{bits: 4,}
pub const OPEN_ONLY_XMP: Self = Self{bits: 4,}
Only the XMP is wanted, allows space/time optimizations.
sourcepub const FORCE_GIVEN_HANDLER: Self = Self{bits: 8,}
pub const FORCE_GIVEN_HANDLER: Self = Self{bits: 8,}
Force use of the given handler (format), do not even verify the format.
sourcepub const OPEN_STRICTLY: Self = Self{bits: 16,}
pub const OPEN_STRICTLY: Self = Self{bits: 16,}
Be strict about only attempting to use the designated file handler, no fallback to other handlers.
sourcepub const OPEN_USE_SMART_HANDLER: Self = Self{bits: 32,}
pub const OPEN_USE_SMART_HANDLER: Self = Self{bits: 32,}
Require the use of a smart handler.
sourcepub const OPEN_USE_PACKET_SCANNING: Self = Self{bits: 64,}
pub const OPEN_USE_PACKET_SCANNING: Self = Self{bits: 64,}
Force packet scanning, do not use a smart handler.
sourcepub const OPEN_LIMITED_SCANNING: Self = Self{bits: 128,}
pub const OPEN_LIMITED_SCANNING: Self = Self{bits: 128,}
Only packet scan files “known” to need scanning.
sourcepub const OPEN_REPAIR_FILE: Self = Self{bits: 256,}
pub const OPEN_REPAIR_FILE: Self = Self{bits: 256,}
Attempt to repair a file opened for update, default is to not open (throw an exception).
sourcepub const OPTIMIZE_FILE_LAYOUT: Self = Self{bits: 512,}
pub const OPTIMIZE_FILE_LAYOUT: Self = Self{bits: 512,}
When updating a file, spend the effort necessary to optimize file layout.
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 OpenFileOptions
impl Binary for OpenFileOptions
sourceimpl BitAnd<OpenFileOptions> for OpenFileOptions
impl BitAnd<OpenFileOptions> for OpenFileOptions
type Output = OpenFileOptions
type Output = OpenFileOptions
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<OpenFileOptions> for OpenFileOptions
impl BitAndAssign<OpenFileOptions> for OpenFileOptions
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<OpenFileOptions> for OpenFileOptions
impl BitOr<OpenFileOptions> for OpenFileOptions
sourcefn bitor(self, other: OpenFileOptions) -> Self
fn bitor(self, other: OpenFileOptions) -> Self
Returns the union of the two sets of flags.
type Output = OpenFileOptions
type Output = OpenFileOptions
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<OpenFileOptions> for OpenFileOptions
impl BitOrAssign<OpenFileOptions> for OpenFileOptions
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<OpenFileOptions> for OpenFileOptions
impl BitXor<OpenFileOptions> for OpenFileOptions
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 = OpenFileOptions
type Output = OpenFileOptions
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<OpenFileOptions> for OpenFileOptions
impl BitXorAssign<OpenFileOptions> for OpenFileOptions
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for OpenFileOptions
impl Clone for OpenFileOptions
sourcefn clone(&self) -> OpenFileOptions
fn clone(&self) -> OpenFileOptions
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 OpenFileOptions
impl Debug for OpenFileOptions
sourceimpl Extend<OpenFileOptions> for OpenFileOptions
impl Extend<OpenFileOptions> for OpenFileOptions
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<OpenFileOptions> for OpenFileOptions
impl FromIterator<OpenFileOptions> for OpenFileOptions
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 Hash for OpenFileOptions
impl Hash for OpenFileOptions
sourceimpl LowerHex for OpenFileOptions
impl LowerHex for OpenFileOptions
sourceimpl Not for OpenFileOptions
impl Not for OpenFileOptions
type Output = OpenFileOptions
type Output = OpenFileOptions
The resulting type after applying the !
operator.
sourceimpl Octal for OpenFileOptions
impl Octal for OpenFileOptions
sourceimpl Ord for OpenFileOptions
impl Ord for OpenFileOptions
sourceimpl PartialEq<OpenFileOptions> for OpenFileOptions
impl PartialEq<OpenFileOptions> for OpenFileOptions
sourcefn eq(&self, other: &OpenFileOptions) -> bool
fn eq(&self, other: &OpenFileOptions) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &OpenFileOptions) -> bool
fn ne(&self, other: &OpenFileOptions) -> bool
This method tests for !=
.
sourceimpl PartialOrd<OpenFileOptions> for OpenFileOptions
impl PartialOrd<OpenFileOptions> for OpenFileOptions
sourcefn partial_cmp(&self, other: &OpenFileOptions) -> Option<Ordering>
fn partial_cmp(&self, other: &OpenFileOptions) -> 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 Sub<OpenFileOptions> for OpenFileOptions
impl Sub<OpenFileOptions> for OpenFileOptions
type Output = OpenFileOptions
type Output = OpenFileOptions
The resulting type after applying the -
operator.
sourceimpl SubAssign<OpenFileOptions> for OpenFileOptions
impl SubAssign<OpenFileOptions> for OpenFileOptions
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for OpenFileOptions
impl UpperHex for OpenFileOptions
impl Copy for OpenFileOptions
impl Eq for OpenFileOptions
impl StructuralEq for OpenFileOptions
impl StructuralPartialEq for OpenFileOptions
Auto Trait Implementations
impl RefUnwindSafe for OpenFileOptions
impl Send for OpenFileOptions
impl Sync for OpenFileOptions
impl Unpin for OpenFileOptions
impl UnwindSafe for OpenFileOptions
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> 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