permcon 1.0.0

A simple library/CLI to parse Linux file permissions and convert them between symbolic and octal notation.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

//! A simple library/CLI to parse Linux file permissions and convert them between symbolic
//! and octal notation.
//!
//! ## Library Usages
//!  
//! ```rust
//! use permcon::{FilePermission, GroupPermission, SourceFormat, SpecialPermission};
//! use permcon::utils::get_filetype_from_char;
//!
//! let perm = FilePermission::try_from("-rwxr-xr-T").unwrap();
//!
//! assert_eq!(perm, FilePermission {
//!     user: GroupPermission {
//!         read: true,
//!         write: true,
//!         execute: true,
//!         special: false,
//!     },
//!     group: GroupPermission {
//!         read: true,
//!         write: false,
//!         execute: true,
//!         special: false,
//!     },
//!     other: GroupPermission {
//!         read: true,
//!         write: false,
//!         execute: false,
//!         special: true,
//!     },
//!     filetype_char: '-',
//!     filetype: get_filetype_from_char('-'),
//!     source_format: Some(SourceFormat::Symbolic),
//!     special: [SpecialPermission::Nil, SpecialPermission::Nil, SpecialPermission::StickyBit],
//! });
//! ```
//! <br>
//!
//! ## CLI usages
//!
//! ```bash,ignore
//! ❯ permcon 1754
//! # -rwxr-xr-T
//!
//! ❯ permcon -- rwxrwxr-t
//! # 1775
//!
//! # Note: a `--` is required if the permission string starts with an `-`.
//! ❯ permcon -- -rwxrwxr-t
//! # 1775
//!
//! ❯ permcon -a -- -rwxrwxr-t
//! # file type    : Regular File
//! # symbolic     : -rwxrwxr-t
//! # octal        : 1775
//! # ------------------------
//! # user (rwx, 7): read, write, execute
//! # group(rwx, 7): read, write, execute
//! # other(r-t, 5): read, _    , (execute, StickyBit)
//! # ------------------------
//! # special permissions: StickyBit
//!
//! ❯ permcon -a 1754
//! # file type    : Unknown
//! # symbolic     : -rwxr-xr-T
//! # octal        : 1754
//! # ------------------------
//! # user (rwx, 7): read, write, execute
//! # group(r-x, 5): read, _    , execute
//! # other(r-T, 4): read, _    , (_, StickyBit)
//! # ------------------------
//! # special permissions: StickyBit
//! ```

pub mod octal;
pub mod perm;
pub mod symbolic;
pub mod utils;
pub use octal::Octal;
pub use perm::{FilePermission, GroupPermission, SourceFormat, SpecialPermission};
pub use symbolic::Symbolic;