Struct obnth::Rename2Flags

pub struct Rename2Flags { /* fields omitted */ }

Linux-specific: Flags for rename2().

If any of these flags are not supported by the filesystem, rename2() will fail with EINVAL.

Implementations

impl Rename2Flags

pub const NOREPLACE: Rename2Flags

Rename the file without replacing the "new" file if it exists (fail with EEXIST in that case).

This requires support from the underlying filesystem; older kernels do not support this for a number of filesystems. See renameat2(2) for more details.

pub const EXCHANGE: Rename2Flags

Atomically exchange the "old" and "new" files.

pub const WHITEOUT: Rename2Flags

Create a "whiteout" object at the source of the rename while performing the rename. Useful for overlay/union filesystems.

Added in Linux 3.18. Requires CAP_MKNOD.

pub const fn empty() -> Rename2Flags

Returns an empty set of flags

pub const fn all() -> Rename2Flags

Returns the set containing all flags.

pub const fn bits(&self) -> c_int

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: c_int) -> Option<Rename2Flags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: c_int) -> Rename2Flags

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

pub const unsafe fn from_bits_unchecked(bits: c_int) -> Rename2Flags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

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: Rename2Flags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for Rename2Flags

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

Formats the value using the given formatter.

impl BitAnd<Rename2Flags> for Rename2Flags

type Output = Rename2Flags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<Rename2Flags> for Rename2Flags

fn bitand_assign(&mut self, other: Rename2Flags)

Disables all flags disabled in the set.

impl BitOr<Rename2Flags> for Rename2Flags

type Output = Rename2Flags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<Rename2Flags> for Rename2Flags

fn bitor_assign(&mut self, other: Rename2Flags)

Adds the set of flags.

impl BitXor<Rename2Flags> for Rename2Flags

type Output = Rename2Flags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<Rename2Flags> for Rename2Flags

fn bitxor_assign(&mut self, other: Rename2Flags)

Toggles the set of flags.

impl Clone for Rename2Flags

fn clone(&self) -> Rename2Flags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Rename2Flags

impl Debug for Rename2Flags

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

Formats the value using the given formatter.

impl Eq for Rename2Flags

impl Extend<Rename2Flags> for Rename2Flags

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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<Rename2Flags> for Rename2Flags

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

Creates a value from an iterator.

impl Hash for Rename2Flags

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for Rename2Flags

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

Formats the value using the given formatter.

impl Not for Rename2Flags

type Output = Rename2Flags

The resulting type after applying the ! operator.

fn not(self) -> Rename2Flags

Returns the complement of this set of flags.

impl Octal for Rename2Flags

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

Formats the value using the given formatter.

impl Ord for Rename2Flags

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Rename2Flags> for Rename2Flags

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

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

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

This method tests for !=.

impl PartialOrd<Rename2Flags> for Rename2Flags

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Rename2Flags

impl StructuralPartialEq for Rename2Flags

impl Sub<Rename2Flags> for Rename2Flags

type Output = Rename2Flags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Rename2Flags> for Rename2Flags

fn sub_assign(&mut self, other: Rename2Flags)

Disables all flags enabled in the set.

impl UpperHex for Rename2Flags

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

Formats the value using the given formatter.