Struct SFlag

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

"File type" flags for mknod and related functions.

Implementations

impl SFlag

const S_IFIFO: Self = _;
const S_IFCHR: Self = _;
const S_IFDIR: Self = _;
const S_IFBLK: Self = _;
const S_IFREG: Self = _;
const S_IFLNK: Self = _;
const S_IFSOCK: Self = _;
const S_IFMT: Self = _;

impl SFlag

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

Get the underlying bits value.

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

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

Convert from a bits value.

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

const fn from_bits_truncate(bits: mode_t) -> Self

Convert from a bits value, unsetting any unknown bits.

const fn from_bits_retain(bits: mode_t) -> 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 SFlag

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

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

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 SFlag

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

impl BitAnd for SFlag

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

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

impl BitAndAssign for SFlag

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for SFlag

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

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

impl BitOrAssign for SFlag

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for SFlag

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

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

impl BitXorAssign for SFlag

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for SFlag

fn clone(&self) -> Self

impl Copy for SFlag

impl Debug for SFlag

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

impl Eq for SFlag

impl Extend<SFlag> for SFlag

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

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

impl Flags for SFlag

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

impl FromIterator<SFlag> for SFlag

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

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

impl Hash for SFlag

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

impl IntoIterator for SFlag

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

impl LowerHex for SFlag

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

impl Not for SFlag

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

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

impl Octal for SFlag

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

impl Ord for SFlag

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

impl PartialEq for SFlag

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

impl PartialOrd for SFlag

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

impl PublicFlags for SFlag

type Primitive = u32;
type Internal = InternalBitFlags;

impl StructuralPartialEq for SFlag

impl Sub for SFlag

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

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 SFlag

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

Auto Trait Implementations

impl Freeze for SFlag

impl RefUnwindSafe for SFlag

impl Send for SFlag

impl Sync for SFlag

impl Unpin for SFlag

impl UnsafeUnpin for SFlag

impl UnwindSafe for SFlag

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for SFlag

fn from(t: T) -> T

Returns the argument unchanged.

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

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

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

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

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

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