Struct Permissions

pub struct Permissions(/* private fields */);

Representation of the various permissions on a file.

Implementations

impl Permissions

pub const fn new() -> Self

Create a new permissions object with zero permissions set.

pub fn suid(&self) -> bool

Tests whether set-user-id bit is set.

pub fn set_suid(&mut self, value: bool) -> &mut Self

Modify the set-user-id bit.

pub fn sgid(&self) -> bool

Tests whether set-group-id bit is set.

pub fn set_sgid(&mut self, value: bool) -> &mut Self

Modify the set-group-id bit.

pub fn svtx(&self) -> bool

Tests whether set-sticky-bit bit is set.

pub fn set_vtx(&mut self, value: bool) -> &mut Self

Modify the set-sticky-bit bit.

pub fn read_by_owner(&self) -> bool

Tests whether read by owner bit is set.

pub fn set_read_by_owner(&mut self, value: bool) -> &mut Self

Modify the read by owner bit.

pub fn write_by_owner(&self) -> bool

Tests whether write by owner bit is set.

pub fn set_write_by_owner(&mut self, value: bool) -> &mut Self

Modify the write by owner bit.

pub fn execute_by_owner(&self) -> bool

Tests whether execute by owner bit is set.

pub fn set_execute_by_owner(&mut self, value: bool) -> &mut Self

Modify the execute by owner bit.

pub fn read_by_group(&self) -> bool

Tests whether read by group bit is set.

pub fn set_read_by_group(&mut self, value: bool) -> &mut Self

Modify the read by group bit.

pub fn write_by_group(&self) -> bool

Tests whether write by group bit is set.

pub fn set_write_by_group(&mut self, value: bool) -> &mut Self

Modify the write by group bit.

pub fn execute_by_group(&self) -> bool

Tests whether execute by group bit is set.

pub fn set_execute_by_group(&mut self, value: bool) -> &mut Self

Modify the execute by group bit.

pub fn read_by_other(&self) -> bool

Tests whether read by other bit is set.

pub fn set_read_by_other(&mut self, value: bool) -> &mut Self

Modify the read by other bit.

pub fn write_by_other(&self) -> bool

Tests whether write by other bit is set.

pub fn set_write_by_other(&mut self, value: bool) -> &mut Self

Modify the write by other bit.

pub fn execute_by_other(&self) -> bool

Tests whether execute by other bit is set.

pub fn set_execute_by_other(&mut self, value: bool) -> &mut Self

Modify the execute by other bit.

pub fn readonly(&self) -> bool

Returns true if these permissions describe an unwritable file that no one can write to.

pub fn set_readonly(&mut self, readonly: bool)

Modifies the readonly flag for this set of permissions.

If the readonly argument is true, it will remove write permissions from all parties.

Conversely, if it’s false, it will permit writing from all parties.

This operation does not modify the filesystem.

To modify the filesystem use the super::fs::Fs::set_permissions or the super::file::File::set_permissions function.

Trait Implementations

impl Clone for Permissions

fn clone(&self) -> Permissions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Permissions

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

Formats the value using the given formatter.

impl Default for Permissions

fn default() -> Self

Returns the “default value” for a type.

impl From<u16> for Permissions

fn from(octet: u16) -> Self

Converts numeric file mode bits permission into a Permissions object.

The numerical file mode bits are defined as follows:

Special mode bits: 4000 Set user ID 2000 Set group ID 1000 Restricted deletion flag or sticky bit

The file’s owner: 400 Read 200 Write 100 Execute/search

Other users in the file’s group: 40 Read 20 Write 10 Execute/search

Other users not in the file’s group: 4 Read 2 Write 1 Execute/search

impl Hash for Permissions

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 PartialEq for Permissions

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

impl Eq for Permissions

impl StructuralPartialEq for Permissions