Struct AtFlags

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

Flags that control how the various *at syscalls behave.

Implementations

impl AtFlags

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

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

const AT_NO_AUTOMOUNT: Self = _;

Don't automount the terminal ("basename") component of pathname if it is a directory that is an automount point.

const AT_EMPTY_PATH: Self = _;

If the provided path is an empty string, operate on the provided directory file descriptor instead.

const AT_EACCESS: Self = _;

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

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) -> c_int

Get the underlying bits value.

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

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

Convert from a bits value.

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

const fn from_bits_truncate(bits: c_int) -> Self

Convert from a bits value, unsetting any unknown bits.

const fn from_bits_retain(bits: c_int) -> 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 AtFlags

const SymlinkFollow: LinkatFlags = LinkatFlags::AT_SYMLINK_FOLLOW;
const NoSymlinkFollow: LinkatFlags = _;

impl AtFlags

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

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

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 AtFlags

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

impl BitAnd for AtFlags

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

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

impl BitAndAssign for AtFlags

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for AtFlags

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

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

impl BitOrAssign for AtFlags

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for AtFlags

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

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

impl BitXorAssign for AtFlags

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for AtFlags

fn clone(&self) -> Self

impl Copy for AtFlags

impl Debug for AtFlags

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

impl Eq for AtFlags

impl Extend<AtFlags> for AtFlags

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

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

impl Flags for AtFlags

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

impl FromIterator<AtFlags> for AtFlags

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

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

impl Hash for AtFlags

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

impl IntoIterator for AtFlags

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

impl LowerHex for AtFlags

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

impl Not for AtFlags

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

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

impl Octal for AtFlags

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

impl Ord for AtFlags

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

impl PartialEq for AtFlags

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

impl PartialOrd for AtFlags

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

impl PublicFlags for AtFlags

type Primitive = i32;
type Internal = InternalBitFlags;

impl StructuralPartialEq for AtFlags

impl Sub for AtFlags

type Output = AtFlags;
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 AtFlags

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 AtFlags

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

Auto Trait Implementations

impl Freeze for AtFlags

impl RefUnwindSafe for AtFlags

impl Send for AtFlags

impl Sync for AtFlags

impl Unpin for AtFlags

impl UnsafeUnpin for AtFlags

impl UnwindSafe for AtFlags

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for AtFlags

fn from(t: T) -> T

Returns the argument unchanged.

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

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

impl<T, U> Into<U> for AtFlags 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 AtFlags where U: Into<T>,

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

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

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