Struct AtFlags 

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

Available on crate features fs or process only.

Flags that control how the various *at syscalls behave.

Implementations

impl AtFlags

pub const AT_SYMLINK_FOLLOW: Self

Available on Unix only.

Used with linkat to create a link to a symbolic link’s target, instead of to the symbolic link itself.

pub const AT_SYMLINK_NOFOLLOW: Self

Available on Unix only.

Used with functions like fstatat to operate on a link itself, instead of the symbolic link’s target.

pub const AT_EACCESS: Self

Available on Unix and non-Android only.

Used with faccessat, the checks for accessibility are performed using the effective user and group IDs instead of the real user and group ID

impl AtFlags

pub const fn empty() -> Self

Available on Unix only.

Get a flags value with all bits unset.

pub const fn all() -> Self

Available on Unix only.

Get a flags value with all known bits set.

pub const fn bits(&self) -> c_int

Available on Unix only.

Get the underlying bits value.

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

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

Available on Unix only.

Convert from a bits value.

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

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

Available on Unix only.

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: c_int) -> Self

Available on Unix only.

Convert from a bits value exactly.

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

Available on Unix only.

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

Available on Unix only.

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Available on Unix only.

Whether all known bits in this flags value are set.

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

Available on Unix only.

Whether any set bits in a source flags value are also set in a target flags value.

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

Available on Unix only.

Whether all set bits in a source flags value are also set in a target flags value.

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

Available on Unix only.

The bitwise or (|) of the bits in two flags values.

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

Available on Unix only.

The intersection of a source flags value with the complement of a target flags value (&!).

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

Available on Unix only.

The bitwise exclusive-or (^) of the bits in two flags values.

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

Available on Unix only.

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

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

Available on Unix only.

The bitwise and (&) of the bits in two flags values.

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

Available on Unix only.

The bitwise or (|) of the bits in two flags values.

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

Available on Unix only.

The intersection of a source flags value with the complement of a target flags value (&!).

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

Available on Unix only.

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

Available on Unix only.

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl AtFlags

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

Available on Unix only.

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

Available on Unix only.

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.

impl AtFlags

pub const FollowSymlink: FchownatFlags

👎Deprecated since 0.28.0: The variant is deprecated, please use AtFlags instead

Available on crate features user and fs only.

pub const NoFollowSymlink: FchownatFlags = FchownatFlags::AT_SYMLINK_NOFOLLOW

👎Deprecated since 0.28.0: The variant is deprecated, please use AtFlags instead

Available on crate features user and fs only.

impl AtFlags

pub const SymlinkFollow: LinkatFlags = LinkatFlags::AT_SYMLINK_FOLLOW

👎Deprecated since 0.28.0: The variant is deprecated, please use AtFlags instead

Available on crate feature fs only.

pub const NoSymlinkFollow: LinkatFlags

👎Deprecated since 0.28.0: The variant is deprecated, please use AtFlags instead

Available on crate feature fs only.

Trait Implementations

impl Binary for AtFlags

Available on Unix only.

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

Formats the value using the given formatter.

impl BitAnd for AtFlags

Available on Unix only.

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

The bitwise and (&) of the bits in two flags values.

type Output = AtFlags

The resulting type after applying the & operator.

impl BitAndAssign for AtFlags

Available on Unix only.

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for AtFlags

Available on Unix only.

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

The bitwise or (|) of the bits in two flags values.

type Output = AtFlags

The resulting type after applying the | operator.

impl BitOrAssign for AtFlags

Available on Unix only.

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for AtFlags

Available on Unix only.

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = AtFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for AtFlags

Available on Unix only.

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for AtFlags

Available on Unix only.

fn clone(&self) -> AtFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AtFlags

Available on Unix only.

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

Formats the value using the given formatter.

impl Extend<AtFlags> for AtFlags

Available on Unix only.

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

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

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 Flags for AtFlags

Available on Unix only.

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

The set of defined flags.

type Bits = i32

The underlying bits type.

fn bits(&self) -> c_int

Get the underlying bits value.

fn from_bits_retain(bits: c_int) -> AtFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits 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 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 a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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 intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<AtFlags> for AtFlags

Available on Unix only.

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

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

impl Hash for AtFlags

Available on Unix only.

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

Available on Unix only.

type Item = AtFlags

The type of the elements being iterated over.

type IntoIter = Iter<AtFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for AtFlags

Available on Unix only.

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

Formats the value using the given formatter.

impl Not for AtFlags

Available on Unix only.

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = AtFlags

The resulting type after applying the ! operator.

impl Octal for AtFlags

Available on Unix only.

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

Formats the value using the given formatter.

impl Ord for AtFlags

Available on Unix only.

fn cmp(&self, other: &AtFlags) -> 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.

impl PartialEq for AtFlags

Available on Unix only.

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for AtFlags

Available on Unix only.

fn partial_cmp(&self, other: &AtFlags) -> 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 PublicFlags for AtFlags

Available on Unix only.

type Primitive = i32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for AtFlags

Available on Unix only.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The resulting type after applying the - operator.

impl SubAssign for AtFlags

Available on Unix only.

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

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 AtFlags

Available on Unix only.

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

Formats the value using the given formatter.

impl Copy for AtFlags

Available on Unix only.

impl Eq for AtFlags

Available on Unix only.

impl StructuralPartialEq for AtFlags

Available on Unix only.