https://github.com/stevelauc/unixpermissionsext

A trivial trait bringing missing functions that are not exposed by PermissionsExt to Permissions on UNIX platforms.
https://github.com/stevelauc/unixpermissionsext

file-permissions set-gid set-uid sticky-bit unix

Last synced: about 1 month ago
JSON representation

A trivial trait bringing missing functions that are not exposed by PermissionsExt to Permissions on UNIX platforms.

• Host: GitHub
• URL: https://github.com/stevelauc/unixpermissionsext
• Owner: SteveLauC
• License: gpl-2.0
• Created: 2022-10-07T05:51:20.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-08T10:30:56.000Z (about 2 years ago)
• Last Synced: 2024-09-16T06:17:50.232Z (2 months ago)
• Topics: file-permissions, set-gid, set-uid, sticky-bit, unix
• Language: Rust
• Homepage:
• Size: 17.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## UNIXPermissionsExt

[![BUILD](https://github.com/stevelauc/UNIXPermissionsExt/workflows/Rust/badge.svg)](https://github.com/stevelauc/UNIXPermissionsExt/actions/workflows/build.yml)

[![crates.io](https://img.shields.io/crates/v/unix_permissions_ext.svg)](https://crates.io/crates/unix_permissions_ext)

[![docs.rs](https://docs.rs/unix_permissions_ext/badge.svg)](https://docs.rs/unix_permissions_ext)

A trivial trait bringing missing functions that are not exposed by

[`std::os::unix::fs::PermissionsExt`](https://doc.rust-lang.org/std/os/unix/fs/trait.PermissionsExt.html)

to [`std::fs::Permissions`](https://doc.rust-lang.org/std/fs/struct.Permissions.html)

on UNIX platforms.

```rust

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:

   ```shell

   $ cd $YOUR_PROJECT

   $ cargo add unix_permissions_ext

   ```

2. Import this trait and use it just like you are using the standard library!

   ```rust

   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:

   

   ```rust

   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

   ```shell

   $ cargo test

   ``` 

2. Format your code

   ```shell

   $ cargo fmt

   ```