Struct cap_primitives::fs::Permissions

source ·

pub struct Permissions { /* private fields */ }

Expand description

Representation of the various permissions on a file.

This corresponds to std::fs::Permissions.

We need to define our own version because the libstd `Permissions` doesn't have a public constructor that we can use.

Implementations§

source §

impl Permissions

source

pub fn from_std(std: Permissions) -> Self

Constructs a new instance of Self from the given std::fs::Permissions.

Examples found in repository ?

src/fs/metadata.rs (line 54)

    fn from_parts(std: fs::Metadata, ext: MetadataExt, file_type: FileType) -> Self {
        Self {
            file_type,
            len: std.len(),
            permissions: Permissions::from_std(std.permissions()),
            modified: std.modified().ok().map(SystemTime::from_std),
            accessed: std.accessed().ok().map(SystemTime::from_std),
            created: std.created().ok().map(SystemTime::from_std),
            ext,
        }
    }

source

pub fn into_std(self, file: &File) -> Result<Permissions>

Consumes self and produces a new instance of std::fs::Permissions.

The `file` parameter works around the fact that we can't construct a `Permissions` object ourselves on Windows.

Examples found in repository ?

src/windows/fs/set_permissions_unchecked.rs (line 20)

pub(crate) fn set_permissions_unchecked(
    start: &fs::File,
    path: &Path,
    perm: Permissions,
) -> io::Result<()> {
    // According to [Rust's documentation], `fs::set_permissions` uses
    // `SetFileAttributes`, and according to [Windows' documentation]
    // `SetFileAttributes` does not follow symbolic links.
    //
    // [Windows' documentation]: https://docs.microsoft.com/en-us/windows/win32/fileio/symbolic-link-effects-on-file-systems-functions#setfileattributes
    // [Rust's documentation]: https://doc.rust-lang.org/std/fs/fn.set_permissions.html#platform-specific-behavior
    let out_path = concatenate(start, path)?;
    fs::set_permissions(out_path, perm.into_std(start)?)
}

source

pub const fn readonly(&self) -> bool

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

This corresponds to std::fs::Permissions::readonly.

Examples found in repository ?

src/fs/permissions.rs (line 68)

    fn _into_std(self, file: &fs::File) -> io::Result<fs::Permissions> {
        let mut permissions = file.metadata()?.permissions();
        permissions.set_readonly(self.readonly());
        Ok(permissions)
    }

source