Struct Mode

pub struct Mode { /* private fields */ }

Implementations

impl Mode

Represents Permissions for a file.

Formatting

String representations of Modes include the extra permission bits, which modify how the executable permissions are displayed if set. If you don’t want to include this functionality, call without_any_extra() before converting the Mode into a string.

pub const fn new() -> Self

Build a mode with absolutely no permission

pub const fn all() -> Self

Build a mode with all permissions given to everybody. This does not include ExtraPermission bits.

pub fn try_from(path: &Path) -> Result<Self, Error>

Return the mode for the given path. On non unix platforms, return Mode::all()

Examples found in repository

examples/ls/main.rs (line 17)

fn list_files() -> io::Result<()> {
    let root = env::current_dir()?;
    println!("Current dir: {}", root.to_string_lossy());
    let mut paths: Vec<PathBuf> = root.read_dir()?
        .filter_map(|e| e.ok())
        .map(|e| e.path())
        .collect();
    paths.sort_unstable();
    for path in paths {
        let mode = Mode::try_from(&path)?;
        let name = path.file_name().unwrap().to_string_lossy();
        println!("{}  {}", mode, name);
    }
    Ok(())
}

pub fn parse<T: AsRef<str>>(s: T) -> Result<Self, ParseError>

Try to parse a mode from a string.

pub const fn is_exe(self) -> bool

Finds if the mode indicates an executable file

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

Indicates whether the passed class/permissions are all present in self

pub const fn has_extra(self, other: ExtraPermission) -> bool

Indicates whether the passed extra permission is present in self

pub const fn with_extra(self, perm: ExtraPermission) -> Self

Return a new mode, with the extra permission set (does nothing if the extra permission is already set for the mode)

pub const fn without_extra(self, perm: ExtraPermission) -> Self

Return a new mode, without the extra permission set (does nothing if the extra permission is not set for the mode)

pub const fn without_any_extra(self) -> Self

Return a new mode, without any extra permission bits set (does nothing if no extra permissions are set for the mode)

pub const fn with_class_perm(self, class: Class, perm: Permission) -> Self

Return a new mode, with the permission added for the class (does nothing if the permission is already given to that class)

pub const fn without_class_perm(self, class: Class, perm: Permission) -> Self

return a new mode, with the permission removed for the class (does nothing if the permission is already given to that class)

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

add the class/permissions of the other mode

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

remove the class/permissions of the other mode

Trait Implementations

impl BitAnd for Mode

type Output = Mode

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for Mode

fn bitand_assign(&mut self, other: Self)

Performs the &= operation.

impl BitOr for Mode

type Output = Mode

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for Mode

fn bitor_assign(&mut self, other: Self)

Performs the |= operation.

impl Clone for Mode

fn clone(&self) -> Mode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mode

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

Formats the value using the given formatter.

impl Default for Mode

fn default() -> Mode

Returns the “default value” for a type.

impl Display for Mode

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

Formats the Mode.

If you want to prevent the extra permission bits from being displayed, use Mode::without_any_extra() to remove them before calling format.

impl From<&Mode> for u32

fn from(mode: &Mode) -> Self

Converts to this type from the input type.

impl From<Mode> for u32

fn from(mode: Mode) -> Self

Converts to this type from the input type.

impl From<u32> for Mode

fn from(value: u32) -> Self

Converts to this type from the input type.

impl FromStr for Mode

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Mode

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 Not for Mode

type Output = Mode

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for Mode

fn eq(&self, other: &Mode) -> 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 Copy for Mode

impl Eq for Mode

impl StructuralPartialEq for Mode