Struct ListCLI

pub struct ListCLI {
    pub format: Option<ListFormat>,
    pub sort: Option<ListSortCriteria>,
    pub no_summary: bool,
    pub show_directories: bool,
    pub show_dot_files: bool,
    pub include_git_files: bool,
    pub targets: Option<Vec<String>>,
}

List files and their actual and cached metadata.

By default, it produces a list of files and directories in the current directory. The list can be formatted by using the –format option. The default format can be set in the config file.

The command doesn’t compute the actual content digest if it’s not requested in the format string.

By default the list is not sorted. You can use the –sort option to sort the list by name, size or timestamp.

Fields

format: Option<ListFormat>

A string for each row of the output table

The following are the keys for each row:

• {{acd8}}: actual content digest from the workspace file. First 8 digits.
• {{acd64}}: actual content digest. All 64 digits.
• {{aft}}: actual file type. Whether the entry is a file (F), directory (D), symlink (S), hardlink (H) or reflink (R).
• {{asz}}: actual size. The size of the workspace file in bytes. It uses MB, GB and TB to represent sizes larger than 1MB.
• {{ats}}: actual timestamp. The timestamp of the workspace file.
• {{name}}: The name of the file or directory.
• {{cst}}: cache status. One of “=”, “>”, “<”, or “X” to show whether the file timestamp is the same as the cached timestamp, newer, older, and not tracked.
• {{rcd8}}: recorded content digest stored in the cache. First 8 digits.
• {{rcd64}}: recorded content digest stored in the cache. All 64 digits.
• {{rrm}}: recorded recheck method. Whether the entry is linked to the workspace as a copy (C), symlink (S), hardlink (H) or reflink (R).
• {{rsz}}: recorded size. The size of the cached content in bytes. It uses MB, GB and TB to represent sizes larged than 1MB.
• {{rts}}: recorded timestamp. The timestamp of the cached content.

The default format can be set with file.list.format in the config file.

TODO: Think how to add a completion to ListFormat

sort: Option<ListSortCriteria>

Sort criteria.

It can be one of none (default), name-asc, name-desc, size-asc, size-desc, ts-asc, ts-desc.

The default option can be set with file.list.sort in the config file.

no_summary: bool

Don’t show total number and size of the listed files.

The default option can be set with file.list.no_summary in the config file.

show_directories: bool

Don’t hide directories

Directories are not listed by default. This flag lists them.

show_dot_files: bool

Don’t hide dot files

If not supplied, hides dot files like .gitignore and .xvcignore

include_git_files: bool

List files tracked by Git.

By default, Xvc doesn’t list files tracked by Git. Supply this option to list them.

targets: Option<Vec<String>>

Files/directories to list.

If not supplied, lists all files under the current directory.

Trait Implementations

impl Args for ListCLI

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for ListCLI

fn clone(&self) -> ListCLI

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for ListCLI

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for ListCLI

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

Formats the value using the given formatter.

impl FromArgMatches for ListCLI

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for ListCLI

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl PartialEq for ListCLI

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl UpdateFromXvcConfig for ListCLI

fn update_from_conf(self, conf: &XvcConfig) -> XvcConfigResult<Box<Self>>

Update the implementing struct from the configuration. Reading the relevant keys and values of the config is in implementor’s responsibility.

impl Eq for ListCLI

impl StructuralPartialEq for ListCLI