Struct file_mode::Mode

pub struct Mode { /* fields omitted */ }

Unix file mode.

All file type, special and protection bits described in sys/stat.h are represented.

The Mode can represent a file mode partially by the use of a bitmask. Only modified bits will be changed in the target file. Modifications specific only to directories (see ProtectionBit::Search) are handled correctly.

The Mode can be displayed as a string according to the POSIX standard for the ls command.

Mode bits can be set with chmod compatible string.

Implementations

impl Mode

pub fn new(mode: u32, mask: u32) -> Mode

Constructs Mode from mode value and mask representing which special and permissions bits will be applied to the target file mode.

pub fn empty() -> Mode

Constructs Mode with no bits sets and empty mask.

pub fn from_path(path: impl AsRef<Path>) -> Result<Mode, Error>

Constructs Mode from mode value of the file represented by the path.

The mask will be set to 0o7777 meaning that all the special and permissions bits will be applied to the target file mode.

pub fn from_path_nofollow(path: impl AsRef<Path>) -> Result<Mode, Error>

Like Mode::from_path but will not follow symbolic links.

pub fn from_file(file: &File) -> Result<Mode, Error>

Constructs Mode from mode value of the file.

The mask will be set to 0o7777 meaning that all the special and permissions bits will be applied to the target file mode.

pub fn mode(&self) -> u32

Gets mode value.

pub fn mode_mask(&self) -> (u32, u32)

Gets mode value and mask that represents bits of the mode that would be applied to the target file mode.

If the mode represents a directory the search bit will be handled accordingly.

pub fn file_type(&self) -> Option<FileType>

Gets FileType if corresponding bit patterns are present and valid in the mode value.

pub fn user_protection(&self, user: User) -> Protection

Gets Protection bits for User.

pub fn user_special(&self, user: User) -> Special

Gets Special bits for User.

• For User::Owner the SpecialBit::SetId bit will represent the set-user-ID mode bit.
• For User::Group the SpecialBit::SetId bit will represent the set-group-ID mode bit.

pub fn add(&mut self, mode: &Mode)

Sets bits that are set in the given mode according to mask.

pub fn sub(&mut self, mode: &Mode)

Clears bits that are set in the given mode according to mask.

pub fn set(&mut self, mode: &Mode)

Sets values of bits that are set or clear in the given mode according to mask.

pub fn forget(&mut self, mode: &Mode)

Forgets values of bits that are set or clear in the given mode by clearing bits in the mask.

pub fn with_file_type(self, file_type: FileType) -> Mode

Returns self with given bit pattern representing FileType set.

pub fn with_protection(self, user: User, protection: &Protection) -> Mode

Returns self with bit pattern and mask for Protection bits set for User.

pub fn with_special(self, user: User, special: &Special) -> Mode

Returns self with bit pattern and mask for Special bits set for User.

• For User::Owner the SpecialBit::SetId bit will represent the set-user-ID mode bit.
• For User::Group the SpecialBit::SetId bit will represent the set-group-ID mode bit.

pub fn set_file_type(&mut self, file_type: FileType)

Sets bit pattern representing given FileType.

pub fn set_protection(&mut self, user: User, protection: &Protection)

Sets bit pattern and mask for Protection bits for User.

pub fn set_special(&mut self, user: User, special: &Special)

Sets bit pattern and mask for Special bits for User.

• For User::Owner the SpecialBit::SetId bit will represent the set-user-ID mode bit.
• For User::Group the SpecialBit::SetId bit will represent the set-group-ID mode bit.

pub fn set_str(&mut self, mode_str: &str) -> Result<(), ModeParseError>

Sets bits according to the mode string (as described in Linux chmod manual).

Only bits described by the string will be represented in the mask.

Note: Current value of mode is used as a reference for operations that use the user as the source of bits (like g+u). Consider constructing Mode using Mode::from_file or Mode::from_path before using this method.

pub fn set_str_umask(
    &mut self,
    mode_str: &str,
    umask: u32
) -> Result<(), ModeParseError>

Like Mode::set_str but allows to specify umask value to use instead of the calling process’s umask.

pub fn apply_umask(&mut self, umask: u32)

Clears protection bits set in the umask value if they were set.

pub fn apply_to(&self, mode: u32) -> u32

Applies mode changes to given mode value.

Only bits set in the mask are modified.

Returns the resulting mode value.

If the mode value passed as an argument represents a directory the search bit will be handled accordingly.

pub fn apply_to_path(&self, path: impl AsRef<Path>) -> Result<u32, Error>

Applies mode changes to the mode of a file represented by the path.

Only bits set in the mask are modified.

Returns the resulting mode value.

If the mode value of the file passed as an argument represents a directory the search bit will be handled accordingly.

The file’s mode is not modified.

pub fn apply_to_path_nofollow(
    &self,
    path: impl AsRef<Path>
) -> Result<u32, Error>

Like Mode::apply_to_path but does not follow symbolic links.

pub fn set_mode_path(&self, path: impl AsRef<Path>) -> Result<u32, Error>

Sets the mode of the file, represented by the path, by applying the mode changes to its current mode.

Only bits set in the mask are modified.

Returns the new file mode value.

If the mode value of the file passed as an argument represents a directory the search bit will be handled accordingly.

The file’s mode is modified.

pub fn set_mode_path_nofollow(
    &self,
    path: impl AsRef<Path>
) -> Result<u32, Error>

Like Mode::set_mode_path but does not follow symbolic links.

pub fn set_mode_file(&self, file: &File) -> Result<u32, Error>

Sets the mode of the file by applying the mode changes to its current mode.

Only bits set in the mask are modified.

Returns the new file mode value.

If the mode value of the file passed as an argument represents a directory the search bit will be handled accordingly.

The file’s mode is modified.

Trait Implementations

impl Clone for Mode

fn clone(&self) -> Mode

Returns a copy of the value.

pub 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 Display for Mode

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

Formats the value using the given formatter.

impl Eq for Mode

impl From<u32> for Mode

fn from(mode: u32) -> Mode

Performs the conversion.

impl FromIterator<Mode> for Mode

fn from_iter<I: IntoIterator<Item = Mode>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for Mode

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Mode> for Mode

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Mode

impl StructuralPartialEq for Mode