Struct RenameFlags

#[repr(transparent)]
pub struct RenameFlags(/* private field */);

Flags for use with renameat2.

Implementations

impl RenameFlags

const RENAME_EXCHANGE: Self = _;

Atomically exchange old_path and new_path.

const RENAME_NOREPLACE: Self = _;

Don't overwrite new_path of the rename. Return an error if new_path already exists.

const RENAME_WHITEOUT: Self = _;

creates a "whiteout" object at the source of the rename at the same time as performing the rename.

This operation makes sense only for overlay/union filesystem implementations.

impl RenameFlags

const fn empty() -> Self

Get a flags value with all bits unset.

const fn all() -> Self

Get a flags value with all known bits set.

const fn bits(&self) -> u32

Get the underlying bits value.

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

const fn from_bits(bits: u32) -> Option<Self>

Convert from a bits value.

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

const fn from_bits_truncate(bits: u32) -> Self

Convert from a bits value, unsetting any unknown bits.

const fn from_bits_retain(bits: u32) -> Self

Convert from a bits value exactly.

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

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.

const fn is_empty(&self) -> bool

Whether all bits in self are unset.

const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

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

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

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

fn insert(&mut self, other: Self)

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

fn remove(&mut self, other: Self)

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.

fn toggle(&mut self, other: Self)

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

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

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

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

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

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

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

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

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.

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

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

const fn complement(self) -> Self

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

impl RenameFlags

const fn iter(&self) -> Iter<RenameFlags>

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.

const fn iter_names(&self) -> IterNames<RenameFlags>

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 RenameFlags

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

impl BitAnd for RenameFlags

type Output = RenameFlags;
fn bitand(self, other: Self) -> Self

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

impl BitAndAssign for RenameFlags

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for RenameFlags

type Output = RenameFlags;
fn bitor(self, other: RenameFlags) -> Self

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

impl BitOrAssign for RenameFlags

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for RenameFlags

type Output = RenameFlags;
fn bitxor(self, other: Self) -> Self

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

impl BitXorAssign for RenameFlags

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for RenameFlags

fn clone(&self) -> Self

impl Copy for RenameFlags

impl Debug for RenameFlags

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

impl Eq for RenameFlags

impl Extend<RenameFlags> for RenameFlags

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

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

impl Flags for RenameFlags

const FLAGS: &'static [Flag<RenameFlags>] = _;
type Bits = u32;
fn bits(&self) -> u32
fn from_bits_retain(bits: u32) -> RenameFlags
fn all_named() -> RenameFlags

impl FromIterator<RenameFlags> for RenameFlags

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

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

impl Hash for RenameFlags

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

impl IntoIterator for RenameFlags

type Item = RenameFlags;
type IntoIter = Iter<RenameFlags>;
fn into_iter(self) -> Self::IntoIter

impl LowerHex for RenameFlags

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

impl Not for RenameFlags

type Output = RenameFlags;
fn not(self) -> Self

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

impl Octal for RenameFlags

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

impl Ord for RenameFlags

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

impl PartialEq for RenameFlags

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

impl PartialOrd for RenameFlags

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

impl PublicFlags for RenameFlags

type Primitive = u32;
type Internal = InternalBitFlags;

impl StructuralPartialEq for RenameFlags

impl Sub for RenameFlags

type Output = RenameFlags;
fn sub(self, other: Self) -> Self

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 SubAssign for RenameFlags

fn sub_assign(&mut self, other: Self)

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 RenameFlags

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

Auto Trait Implementations

impl Freeze for RenameFlags

impl RefUnwindSafe for RenameFlags

impl Send for RenameFlags

impl Sync for RenameFlags

impl Unpin for RenameFlags

impl UnsafeUnpin for RenameFlags

impl UnwindSafe for RenameFlags

Blanket Implementations

impl<T> Any for RenameFlags where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for RenameFlags where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for RenameFlags where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for RenameFlags where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for RenameFlags

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> ToOwned for RenameFlags where T: Clone,

type Owned = T;
fn to_owned(&self) -> T
fn clone_into(&self, target: &mut T)

impl<T, U> Into<U> for RenameFlags where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for RenameFlags where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for RenameFlags where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>