Struct mtree::Params

pub struct Params {
    pub checksum: Option<u64>,
    pub device: Option<Device>,
    pub contents: Option<PathBuf>,
    pub flags: Option<Vec<u8>>,
    pub gid: Option<u64>,
    pub gname: Option<SmallVec<[u8; 32]>>,
    pub ignore: bool,
    pub inode: Option<u64>,
    pub link: Option<PathBuf>,
    pub md5: Option<u128>,
    pub mode: Option<FileMode>,
    pub nlink: Option<u64>,
    pub no_change: bool,
    pub optional: bool,
    pub resident_device: Option<Device>,
    pub rmd160: Option<[u8; 20]>,
    pub sha1: Option<[u8; 20]>,
    pub sha256: Option<[u8; 32]>,
    pub sha384: Option<Array48<u8>>,
    pub sha512: Option<Array64<u8>>,
    pub size: Option<u64>,
    pub time: Option<SystemTime>,
    pub file_type: Option<Type>,
    pub uid: Option<u64>,
    pub uname: Option<SmallVec<[u8; 32]>>,
}

All possible parameters to an entry.

All parameters are optional. ignore, nochange and optional all have no value, and so true represets their presence.

Fields

checksum: Option<u64>

cksum The checksum of the file using the default algorithm specified by the cksum(1) utility.

device: Option<Device>

device The device number for block or char file types.

contents: Option<PathBuf>

contents The full pathname of a file that holds the contents of this file.

flags: Option<Vec<u8>>

flags The file flags as a symbolic name.

gid: Option<u64>

gid The file group as a numeric value.

gname: Option<SmallVec<[u8; 32]>>

gname The file group as a symbolic name.

The name can be up to 32 chars and must match regex [a-z_][a-z0-9_-]*[$]?.

ignore: bool

ignore Ignore any file hierarchy below this line.

inode: Option<u64>

inode The inode number.

link: Option<PathBuf>

link The target of the symbolic link when type=link.

md5: Option<u128>

md5|md5digest The MD5 message digest of the file.

mode: Option<FileMode>

mode The current file's permissions as a numeric (octal) or symbolic value.

nlink: Option<u64>

nlink The number of hard links the file is expected to have.

no_change: bool

nochange Make sure this file or directory exists but otherwise ignore all attributes.

optional: bool

optional The file is optional; do not complain about the file if it is not in the file hierarchy.

resident_device: Option<Device>

resdevice The "resident" device number of the file, e.g. the ID of the device that contains the file. Its format is the same as the one for device.

rmd160: Option<[u8; 20]>

rmd160|rmd160digest|ripemd160digest The RIPEMD160 message digest of the file.

sha1: Option<[u8; 20]>

sha1|sha1digest The FIPS 160-1 ("SHA-1") message digest of the file.

sha256: Option<[u8; 32]>

sha256|sha256digest The FIPS 180-2 ("SHA-256") message digest of the file.

sha384: Option<Array48<u8>>

sha384|sha384digest The FIPS 180-2 ("SHA-384") message digest of the file.

sha512: Option<Array64<u8>>

sha512|sha512digest The FIPS 180-2 ("SHA-512") message digest of the file.

size: Option<u64>

size The size, in bytes, of the file.

time: Option<SystemTime>

time The last modification time of the file.

file_type: Option<Type>

type The type of the file.

uid: Option<u64>

The file owner as a numeric value.

uname: Option<SmallVec<[u8; 32]>>

The file owner as a symbolic name.

The name can be up to 32 chars and must match regex [a-z_][a-z0-9_-]*[$]?.

Trait Implementations

impl Default for Params

fn default() -> Params

Returns the "default value" for a type.

impl Debug for Params

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for Params

fn clone(&self) -> Params

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Eq for Params

impl PartialEq for Params

fn eq(&self, other: &Params) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Params) -> bool

This method tests for !=.

impl Ord for Params

fn cmp(&self, other: &Params) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl PartialOrd for Params

fn partial_cmp(&self, other: &Params) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Params) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Params) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Params) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Params) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Hash for Params

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl Display for Params

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.