Struct FscryptPolicyFlags 

pub struct FscryptPolicyFlags(/* private fields */);

Flags configuring an fscrypt encryption policy.

These flags are byte-compatible with the Linux fscrypt UAPI: each member has the same value as the corresponding FSCRYPT_POLICY_FLAG* constant in <linux/fscrypt.h>, so the flags field of a Linux fscrypt_policy_v2 can be converted to and from this type without translation.

Implementations

impl FscryptPolicyFlags

pub const PAD_8: FscryptPolicyFlags

Pad encrypted filenames to 8-byte boundaries (when neither PAD_8 nor PAD_16 is set, filenames are padded to 4-byte boundaries; when both PAD_8 and PAD_16 are set, filenames are padded to 32-byte boundaries).

pub const PAD_16: FscryptPolicyFlags

Pad encrypted filenames to 16-byte boundaries.

pub const DIRECT_KEY: FscryptPolicyFlags

Use direct key mode.

pub const IV_INO_LBLK_64: FscryptPolicyFlags

Derive IVs/DUNs by hashing the inode number and combining with the 64-bit logical block number (FSCRYPT_POLICY_FLAG_IV_INO_LBLK_64).

pub const IV_INO_LBLK_32: FscryptPolicyFlags

Derive IVs/DUNs by hashing the main key and inode number and adding the 32-bit logical block number (FSCRYPT_POLICY_FLAG_IV_INO_LBLK_32).

impl FscryptPolicyFlags

pub const fn empty() -> FscryptPolicyFlags

Get a flags value with all bits unset.

pub const fn all() -> FscryptPolicyFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u8

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u8) -> Option<FscryptPolicyFlags>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u8) -> FscryptPolicyFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u8) -> FscryptPolicyFlags

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<FscryptPolicyFlags>

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 is_empty(&self) -> bool

Whether all bits in self are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in other are also set in self.

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

Whether all set bits in other are also set in self.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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: FscryptPolicyFlags)

The bitwise exclusive-or (^) of the bits in self and other.

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

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: FscryptPolicyFlags) -> FscryptPolicyFlags

The bitwise and (&) of the bits in self and other.

pub const fn union(self, other: FscryptPolicyFlags) -> FscryptPolicyFlags

The bitwise or (|) of the bits in self and other.

pub const fn difference(self, other: FscryptPolicyFlags) -> FscryptPolicyFlags

The intersection of self with the complement of other (&!).

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: FscryptPolicyFlags, ) -> FscryptPolicyFlags

The bitwise exclusive-or (^) of the bits in self and other.

pub const fn complement(self) -> FscryptPolicyFlags

The bitwise negation (!) of the bits in self, truncating the result.

impl FscryptPolicyFlags

pub const fn iter(&self) -> Iter<FscryptPolicyFlags>

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<FscryptPolicyFlags>

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 FscryptPolicyFlags

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

Formats the value using the given formatter.

impl BitAnd for FscryptPolicyFlags

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

The bitwise and (&) of the bits in self and other.

type Output = FscryptPolicyFlags

The resulting type after applying the & operator.

impl BitAndAssign for FscryptPolicyFlags

fn bitand_assign(&mut self, other: FscryptPolicyFlags)

The bitwise and (&) of the bits in self and other.

impl BitOr for FscryptPolicyFlags

fn bitor(self, other: FscryptPolicyFlags) -> FscryptPolicyFlags

The bitwise or (|) of the bits in self and other.

type Output = FscryptPolicyFlags

The resulting type after applying the | operator.

impl BitOrAssign for FscryptPolicyFlags

fn bitor_assign(&mut self, other: FscryptPolicyFlags)

The bitwise or (|) of the bits in self and other.

impl BitXor for FscryptPolicyFlags

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

The bitwise exclusive-or (^) of the bits in self and other.

type Output = FscryptPolicyFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for FscryptPolicyFlags

fn bitxor_assign(&mut self, other: FscryptPolicyFlags)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for FscryptPolicyFlags

fn clone(&self) -> FscryptPolicyFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FscryptPolicyFlags

impl Debug for FscryptPolicyFlags

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

Formats the value using the given formatter.

impl<___E> Encode<FscryptPolicyFlags, ___E> for FscryptPolicyFlags

where ___E: ?Sized,

fn encode( self, encoder: &mut ___E, out: &mut MaybeUninit<FscryptPolicyFlags>, _: (), ) -> Result<(), EncodeError>

Encodes this value into an encoder and output.

const COPY_OPTIMIZATION: CopyOptimization<Self, W> = _

Whether the conversion from Self to W is equivalent to copying the raw bytes of Self.

impl<'a, ___E> Encode<FscryptPolicyFlags, ___E> for &'a FscryptPolicyFlags

where ___E: ?Sized,

fn encode( self, _: &mut ___E, out: &mut MaybeUninit<FscryptPolicyFlags>, _: (), ) -> Result<(), EncodeError>

Encodes this value into an encoder and output.

const COPY_OPTIMIZATION: CopyOptimization<Self, W> = _

Whether the conversion from Self to W is equivalent to copying the raw bytes of Self.

impl Eq for FscryptPolicyFlags

impl Extend<FscryptPolicyFlags> for FscryptPolicyFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = FscryptPolicyFlags>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: T)

🔬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 Flags for FscryptPolicyFlags

const FLAGS: &'static [Flag<FscryptPolicyFlags>]

The set of defined flags.

type Bits = u8

The underlying bits type.

fn bits(&self) -> u8

Get the underlying bits value.

fn from_bits_retain(bits: u8) -> FscryptPolicyFlags

Convert from a bits value exactly.

fn all_named() -> FscryptPolicyFlags

Get a flags value with all bits from named flags set.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by [Self::FLAGS].

fn iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in other are also set in self.

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

where Self: Sized,

Whether all set bits in other are also set in self.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

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

where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl From<FscryptPolicyFlags> for FscryptPolicyFlags

fn from(wire: FscryptPolicyFlags) -> FscryptPolicyFlags

Converts to this type from the input type.

impl From<FscryptPolicyFlags> for FscryptPolicyFlags

fn from(natural: FscryptPolicyFlags) -> FscryptPolicyFlags

Converts to this type from the input type.

impl FromIterator<FscryptPolicyFlags> for FscryptPolicyFlags

fn from_iter<T>(iterator: T) -> FscryptPolicyFlags

where T: IntoIterator<Item = FscryptPolicyFlags>,

The bitwise or (|) of the bits in each flags value.

impl FromWire<FscryptPolicyFlags> for FscryptPolicyFlags

fn from_wire(wire: FscryptPolicyFlags) -> FscryptPolicyFlags

Converts the given owned value to this type.

const COPY_OPTIMIZATION: CopyOptimization<W, Self> = _

Whether the conversion from W to Self is equivalent to copying the raw bytes of W.

impl FromWireRef<FscryptPolicyFlags> for FscryptPolicyFlags

fn from_wire_ref(wire: &FscryptPolicyFlags) -> FscryptPolicyFlags

Converts the given reference to this type.

impl Hash for FscryptPolicyFlags

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

where __H: Hasher,

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 IntoIterator for FscryptPolicyFlags

type Item = FscryptPolicyFlags

The type of the elements being iterated over.

type IntoIter = Iter<FscryptPolicyFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <FscryptPolicyFlags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for FscryptPolicyFlags

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

Formats the value using the given formatter.

impl Not for FscryptPolicyFlags

fn not(self) -> FscryptPolicyFlags

The bitwise negation (!) of the bits in self, truncating the result.

type Output = FscryptPolicyFlags

The resulting type after applying the ! operator.

impl Octal for FscryptPolicyFlags

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

Formats the value using the given formatter.

impl Ord for FscryptPolicyFlags

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for FscryptPolicyFlags

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FscryptPolicyFlags

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for FscryptPolicyFlags

impl Sub for FscryptPolicyFlags

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

The intersection of self with the complement of other (&!).

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 = FscryptPolicyFlags

The resulting type after applying the - operator.

impl SubAssign for FscryptPolicyFlags

fn sub_assign(&mut self, other: FscryptPolicyFlags)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for FscryptPolicyFlags

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

Formats the value using the given formatter.