12 releases (3 stable)

2.0.0 May 11, 2022
1.0.1 Jan 28, 2022
1.0.0 May 20, 2020
0.1.8 Nov 18, 2019
0.1.6 Jul 5, 2019

#47 in Unix APIs

Download history 1023/week @ 2022-01-29 1789/week @ 2022-02-05 1872/week @ 2022-02-12 1743/week @ 2022-02-19 1410/week @ 2022-02-26 1246/week @ 2022-03-05 1268/week @ 2022-03-12 1765/week @ 2022-03-19 1364/week @ 2022-03-26 1294/week @ 2022-04-02 1286/week @ 2022-04-09 1654/week @ 2022-04-16 1684/week @ 2022-04-23 1372/week @ 2022-04-30 1514/week @ 2022-05-07 1405/week @ 2022-05-14

6,216 downloads per month
Used in 7 crates (4 directly)

MIT license

15KB
239 lines

MIT Latest Version docs Chat on Miaou

umask

A light utility helping with unix mode representation, with strong types to avoid misusing constants.

The Mode struct implements Display and prints as "rwxrwxrwx"

Import

In Cargo.toml:

umask = "'2.0"

Usage

use umask::*;

// You can build from a number:
assert_eq!("rw-r--r--", Mode::from(0b110100100).to_string());
assert_eq!("rw-r--r--", Mode::from(0o644).to_string());

// You may use `|` to combine class permissions:
let mu = Mode::from(0o640);
let mo = Mode::from(0o044);
assert_eq!("rw-r--r--", (mu | mo).to_string());
assert_eq!("---r-----", (mu & mo).to_string());

// You can use more semantic constructs:
let m = Mode::all()
    .without(ALL_EXEC);
assert_eq!("rw-rw-rw-", m.to_string());
let mut m = Mode::new()
    .with_class_perm(ALL, READ)
    .with_class_perm(USER, WRITE);
assert_eq!("rw-r--r--", m.to_string());
// (semantic functions can be used in const declarations)

// Or
m |= ALL_EXEC;
assert_eq!("rwxr-xr-x", m.to_string());
let m = ALL_READ | USER_WRITE;
assert_eq!("rw-r--r--", m.to_string());

// Displaying the mode can be done with the `Display`
// implementation but also bit per bit for more control
assert_eq!(
    m.to_string().chars().next().unwrap(), // first char: 'r' or '-'
    if m.has(USER_READ) { 'r' } else { '-' },
);

// The `Display` implementation shows the extra permission bits
// (setuid, setgid and sticky):
let mut m = Mode::all()
    .with_extra(STICKY)
    .with_extra(SETUID)
    .with_extra(SETGID);
assert_eq!("rwsrwsrwt", m.to_string());

// But you can remove those bits for display if you want the
// sometimes more familiar 'x' for execution:
assert_eq!("rwxrwxrwx", m.without_any_extra().to_string());

No runtime deps