Struct file_system::Permissions

[+] Show declaration

pub struct Permissions(FilePermissions);

[−] Expand description

Representation of the various permissions on a file.

This module only currently provides one bit of information, Permissions::readonly, which is exposed on all currently supported platforms. Unix-specific functionality, such as mode bits, is available through the PermissionsExt trait.

Implementations

impl Permissions[−]

pub fn readonly(&self) -> bool[−]

Returns true if these permissions describe a readonly (unwritable) file.

Examples

use std::fs::File;

fn main() -> std::io::Result<()> {
    let mut f = File::create("foo.txt")?;
    let metadata = f.metadata()?;

    assert_eq!(false, metadata.permissions().readonly());
    Ok(())
}

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

Modifies the readonly flag for this set of permissions. If the readonly argument is true, using the resulting Permission will update file permissions to forbid writing. Conversely, if it’s false, using the resulting Permission will update file permissions to allow writing.

This operation does not modify the filesystem. To modify the filesystem use the set_permissions function.

Examples

use std::fs::File;

fn main() -> std::io::Result<()> {
    let f = File::create("foo.txt")?;
    let metadata = f.metadata()?;
    let mut permissions = metadata.permissions();

    permissions.set_readonly(true);

    // filesystem doesn't change
    assert_eq!(false, metadata.permissions().readonly());

    // just this particular `permissions`.
    assert_eq!(true, permissions.readonly());
    Ok(())
}

Trait Implementations

impl Clone for Permissions[+]

[+] Show hidden undocumented items

pub fn clone(&self) -> Permissions[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for Permissions[+]

[+] Show hidden undocumented items

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl Eq for Permissions

impl PartialEq<Permissions> for Permissions[+]

[+] Show hidden undocumented items

pub fn eq(&self, other: &Permissions) -> bool[−]

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

pub fn ne(&self, other: &Permissions) -> bool[−]

This method tests for !=.

impl PermissionsExt for Permissions[+]

[+] Show hidden undocumented items

pub fn mode(&self) -> u32[−]

Returns the underlying raw st_mode bits that contain the standard Unix permissions for this file.

pub fn set_mode(&mut self, mode: u32)[−]

Sets the underlying raw bits for this set of permissions.

pub fn from_mode(mode: u32) -> Permissions[−]

Creates a new instance of Permissions from the given set of Unix permission bits.

impl StructuralEq for Permissions

impl StructuralPartialEq for Permissions