Struct rustix::fs::Mode

pub struct Mode { /* fields hidden */ }

Documentation

S_I* constants for use with openat, chmodat, and fchmod.

Implementations

impl Mode

const RWXU: Self = _

S_IRWXU

const RUSR: Self = _

S_IRUSR

const WUSR: Self = _

S_IWUSR

const XUSR: Self = _

S_IXUSR

const RWXG: Self = _

S_IRWXG

const RGRP: Self = _

S_IRGRP

const WGRP: Self = _

S_IWGRP

const XGRP: Self = _

S_IXGRP

const RWXO: Self = _

S_IRWXO

const ROTH: Self = _

S_IROTH

const WOTH: Self = _

S_IWOTH

const XOTH: Self = _

S_IXOTH

const SUID: Self = _

S_ISUID

const SGID: Self = _

S_ISGID

const SVTX: Self = _

S_ISVTX

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&Self) -> RawMode

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: RawMode) -> $crate::_core::option::Option<Self>

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

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

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

pub const unsafe fn from_bits_unchecked(bits: RawMode) -> Self

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

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

pub fn toggle(&mut Self, other: Self)

Toggles the specified flags in-place.

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

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

#[must_use]
pub const fn intersection(Self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

#[must_use]
pub const fn union(Self, other: Self) -> Self

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

#[must_use]
pub const fn difference(Self, other: Self) -> Self

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

#[must_use]
pub const fn symmetric_difference(Self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

#[must_use]
pub const fn complement(Self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

impl Mode

pub const fn from_raw_mode(st_mode: RawMode) -> Self

Construct a Mode from the mode bits of the st_mode field of a Stat.

pub const fn as_raw_mode(Self) -> RawMode

Construct an st_mode value from Stat.

Trait Implementations

impl Binary for Mode

fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Result

impl BitAnd<Mode> for Mode

type Output = Mode

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<Mode> for Mode

fn bitand_assign(&mut Self, other: Self)

Disables all flags disabled in the set.

impl BitOr<Mode> for Mode

type Output = Mode

fn bitor(Self, other: Mode) -> Self

Returns the union of the two sets of flags.

impl BitOrAssign<Mode> for Mode

fn bitor_assign(&mut Self, other: Self)

Adds the set of flags.

impl BitXor<Mode> for Mode

type Output = Mode

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

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

impl BitXorAssign<Mode> for Mode

fn bitxor_assign(&mut Self, other: Self)

Toggles the set of flags.

impl Clone for Mode

fn clone(&Self) -> Mode

impl Copy for Mode

impl Debug for Mode

fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Result

impl Eq for Mode

impl Extend<Mode> for Mode

fn extend<T: $crate::_core::iter::IntoIterator<Item = Self>>(&mut Self, iterator: T)

impl FromIterator<Mode> for Mode

fn from_iter<T: $crate::_core::iter::IntoIterator<Item = Self>>(iterator: T) -> Self

impl Hash for Mode

fn hash<__H: $crate::hash::Hasher>(&Self, state: &mut __H) -> ()

impl LowerHex for Mode

fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Result

impl Not for Mode

type Output = Mode

fn not(Self) -> Self

Returns the complement of this set of flags.

impl Octal for Mode

fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Result

impl Ord for Mode

fn cmp(&Self, other: &Mode) -> $crate::cmp::Ordering

impl PartialEq<Mode> for Mode

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

fn ne(&Self, other: &Mode) -> bool

impl PartialOrd<Mode> for Mode

fn partial_cmp(&Self, other: &Mode) -> $crate::option::Option<$crate::cmp::Ordering>

impl StructuralEq for Mode

impl StructuralPartialEq for Mode

impl Sub<Mode> for Mode

type Output = Mode

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

Returns the set difference of the two sets of flags.

impl SubAssign<Mode> for Mode

fn sub_assign(&mut Self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for Mode

fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Result

Auto Trait Implementations

impl RefUnwindSafe for Mode

impl Send for Mode

impl Sync for Mode

impl Unpin for Mode

impl UnwindSafe for Mode

Blanket Implementations

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

fn type_id(&Self) -> TypeId

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

fn borrow(&Self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

type Owned = T

fn to_owned(&Self) -> T

fn clone_into(&Self, target: &mut T)

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

type Error = <U as TryFrom<T>>::Error

fn try_into(Self) -> Result<U, <U as TryFrom<T>>::Error>