Struct `ResolveFlag`

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

Path resolution flags.

See path resolution(7) for details of the resolution process.

Implementations

`impl ResolveFlag`

const RESOLVE_BENEATH: Self = _;

Do not permit the path resolution to succeed if any component of the resolution is not a descendant of the directory indicated by dirfd. This causes absolute symbolic links (and absolute values of pathname) to be rejected.

const RESOLVE_IN_ROOT: Self = _;

Treat the directory referred to by dirfd as the root directory while resolving pathname.

const RESOLVE_NO_MAGICLINKS: Self = _;

Disallow all magic-link resolution during path resolution. Magic links are symbolic link-like objects that are most notably found in proc(5); examples include /proc/[pid]/exe and /proc/[pid]/fd/*.

See symlink(7) for more details.

const RESOLVE_NO_SYMLINKS: Self = _;

Disallow resolution of symbolic links during path resolution. This option implies RESOLVE_NO_MAGICLINKS.

const RESOLVE_NO_XDEV: Self = _;

Disallow traversal of mount points during path resolution (including all bind mounts).

`impl ResolveFlag`

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_ulonglong

Get the underlying bits value.

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

const fn from_bits(bits: c_ulonglong) -> 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_ulonglong) -> Self

Convert from a bits value, unsetting any unknown bits.

const fn from_bits_retain(bits: c_ulonglong) -> 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 ResolveFlag`

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

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

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.