Rust/umanux
1
0
Fork 0
Code Issues 2 Pull Requests Projects Releases Wiki Activity

doc update for enum Gecos

Browse Source
This commit is contained in:
Dietrich 2020-09-30 18:23:44 +02:00
parent 676a5218e6
commit 5000fba6e7
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/passwd.rs
View File

@ -37,7 +37,12 @@ pub struct Uid {
pub struct Gid { pub struct Gid {
gid: u32, gid: u32,
} }
/// The gecos field of a user.
///
/// In the `/etc/passwd` file this field is a `,` sepparated list of items.
/// The first 4 values are more or less standardised to be full name, room, phone at work and phone at home. After that there can be some extra fields often containing the emailadress and even additional information.
///
/// This enum represents the first 4 values by name and adds the other values to a list of strings [`Gecos::Detail`]. If only one field is found and no `,` at all this value is used as a human readable comment [`Gecos::Simple`].
#[derive(Debug, PartialEq, Eq)] #[derive(Debug, PartialEq, Eq)]
pub enum Gecos<'a> { pub enum Gecos<'a> {
Detail { Detail {