Struct devicemapper::DmFlags

pub struct DmFlags { /* private fields */ }

Flags used by devicemapper.

Implementations

impl DmFlags

pub const DM_READONLY: Self = _

In: Device should be read-only. Out: Device is read-only.

pub const DM_SUSPEND: Self = _

In: Device should be suspended. Out: Device is suspended.

pub const DM_PERSISTENT_DEV: Self = _

In: Use passed-in minor number.

pub const DM_STATUS_TABLE: Self = _

In: STATUS command returns table info instead of status.

pub const DM_ACTIVE_PRESENT: Self = _

Out: Active table is present.

pub const DM_INACTIVE_PRESENT: Self = _

Out: Inactive table is present.

pub const DM_BUFFER_FULL: Self = _

Out: Passed-in buffer was too small.

pub const DM_SKIP_BDGET: Self = _

Obsolete.

pub const DM_SKIP_LOCKFS: Self = _

In: Avoid freezing filesystem when suspending.

pub const DM_NOFLUSH: Self = _

In: Suspend without flushing queued I/Os.

pub const DM_QUERY_INACTIVE_TABLE: Self = _

In: Query inactive table instead of active.

pub const DM_UEVENT_GENERATED: Self = _

Out: A uevent was generated, the caller may need to wait for it.

pub const DM_UUID: Self = _

In: Rename affects UUID field, not name field.

pub const DM_SECURE_DATA: Self = _

In: All buffers are wiped after use. Use when handling crypto keys.

pub const DM_DATA_OUT: Self = _

Out: A message generated output data.

pub const DM_DEFERRED_REMOVE: Self = _

In: Do not remove in-use devices. Out: Device scheduled to be removed when closed.

pub const DM_INTERNAL_SUSPEND: Self = _

Out: Device is suspended internally.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> __u32

Returns the raw value of the flags currently stored.

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.

pub const fn from_bits_truncate(bits: __u32) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

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.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

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.

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.

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.

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.

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

impl Binary for DmFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd<DmFlags> for DmFlags

fn bitand(self, other: Self) -> Self

Returns the intersection between the two sets of flags.

type Output = DmFlags

The resulting type after applying the & operator.

impl BitAndAssign<DmFlags> for DmFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<DmFlags> for DmFlags

fn bitor(self, other: DmFlags) -> Self

Returns the union of the two sets of flags.

type Output = DmFlags

The resulting type after applying the | operator.

impl BitOrAssign<DmFlags> for DmFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<DmFlags> for DmFlags

fn bitxor(self, other: Self) -> Self

Returns the left flags, but with all the right flags toggled.

type Output = DmFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<DmFlags> for DmFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for DmFlags

fn clone(&self) -> DmFlags

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DmFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DmFlags

fn default() -> DmFlags

Returns the “default value” for a type.

impl Extend<DmFlags> for DmFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<DmFlags> for DmFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl Hash for DmFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for DmFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Not for DmFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = DmFlags

The resulting type after applying the ! operator.

impl Octal for DmFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for DmFlags

fn cmp(&self, other: &DmFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<DmFlags> for DmFlags

fn eq(&self, other: &DmFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<DmFlags> for DmFlags

fn partial_cmp(&self, other: &DmFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<DmFlags> for DmFlags

fn sub(self, other: Self) -> Self

Returns the set difference of the two sets of flags.

type Output = DmFlags

The resulting type after applying the - operator.

impl SubAssign<DmFlags> for DmFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for DmFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for DmFlags

impl Eq for DmFlags

impl StructuralEq for DmFlags

impl StructuralPartialEq for DmFlags