unix_permissions_ext

Crates.iounix_permissions_ext
lib.rsunix_permissions_ext
version0.1.2
sourcesrc
created_at2022-10-07 08:11:01.81948
updated_at2022-10-08 10:31:51.884486
descriptionA trivial trait bringing missing functions that are not exposed by PermissionsExt to Permissions on UNIX platforms.
homepage
repositoryhttps://github.com/SteveLauC/UNIXPermissionsExt
max_upload_size
id682725
size32,339
SteveLauC (SteveLauC)

documentation

README

UNIXPermissionsExt

BUILD crates.io docs.rs

A trivial trait bringing missing functions that are not exposed by std::os::unix::fs::PermissionsExt to std::fs::Permissions on UNIX platforms.

pub trait UNIXPermissionsExt {
    fn set_uid(&self) -> bool;
    fn set_gid(&self) -> bool;
    fn sticky_bit(&self) -> bool;
    fn readable_by_owner(&self) -> bool;
    fn writable_by_owner(&self) -> bool;
    fn executable_by_owner(&self) -> bool;
    fn readable_by_group(&self) -> bool;
    fn writable_by_group(&self) -> bool;
    fn executable_by_group(&self) -> bool;
    fn readable_by_other(&self) -> bool;
    fn writable_by_other(&self) -> bool;
    fn executable_by_other(&self) -> bool;
    fn stringify(&self) -> String;
}

impl UNIXPermissionsExt for Permissions {
    ...
}

Usage

  1. Add it to your dependency:

    $ cd $YOUR_PROJECT
    $ cargo add unix_permissions_ext
    
  2. Import this trait and use it just like you are using the standard library!

    use std::fs::metadata;
    use unix_permissions_ext::UNIXPermissionsExt;
    
    let metadata = metadata("/usr/bin/passwd").expect("can not fetch metadata");
    let permission = metadata.permissions();
    
    assert!(permission.set_uid());
    println!("Permission: {}", permission.stringify());
    
  3. To use these functions directly with the mode_t type, consider importing raw_fn module:

    use unix_permissions_ext::raw_fn::*;
    

Contributing

Contributions of all forms are welcome, feel free to file an issue or make a pull request!

Test before your commit

  1. Pass the tests

    $ cargo test
    
  2. Format your code

    $ cargo fmt
    
Commit count: 7

cargo fmt