Struct rocfl::cmd::opts::ListCmd

pub struct ListCmd {

    pub logical_dirs: bool,
    pub long: bool,
    pub physical: bool,
    pub digest: bool,
    pub header: bool,
    pub tsv: bool,
    pub staged: bool,
    pub version: Option<VersionNum>,
    pub sort: Field,
    pub reverse: bool,
    pub objects: bool,
    pub object_id: Option<String>,
    pub path: Option<String>,
}

List objects or files within objects

When listing objects, rocfl must scan the entire repository, and can therefore be very slow when operating on large repositories or repositories in S3. Results will be printed as soon as they’re found so long as the results do not need to be sorted or displayed in a formatted table. Use ‘-t’ to disable the table formatting.

This command supports glob expressions. When you use globs, it is usually a good idea to quote them so that your shell does not attempt to expand them.

Fields

logical_dirs: bool

Interpret logical path parts as logical directories

Instead of listing all of the paths in the object, only the paths that are direct logical children of the query are returned. This is analogous to executing ls on the local filesystem.

long: bool

Enable long output

Format: Version, Updated, Name (Object ID or Logical Path)

physical: bool

Display the physical path to the item relative the repository storage root

digest: bool

Display the digest of the item in the format ‘algorithm:digest’

header: bool

Display a header row

tsv: bool

Tab separate the output

staged: bool

List staged objects or the contents of a specific staged object

version: Option<VersionNum>

Version of the object to list

sort: Field

Field to sort on. By default, objects are unsorted and object contents are sorted on name.

reverse: bool

Reverse the order of the sort

objects: bool

List only objects; not their contents. Useful when glob matching on object IDs

object_id: Option<String>

ID of the object to list. May be a glob when used with ‘-o’.

path: Option<String>

Path glob of files to list. Requires an object to be specified.

Trait Implementations

impl Args for ListCmd

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

Append to App so it can instantiate Self.

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

Append to App so it can update self.

impl Debug for ListCmd

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

Formats the value using the given formatter.

impl From<ListCmd> for Command

fn from(v: ListCmd) -> Command

Performs the conversion.

impl FromArgMatches for ListCmd

fn from_arg_matches(__clap_arg_matches: &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.

impl TryInto<ListCmd> for Command

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<ListCmd, <Self as TryInto<ListCmd>>::Error>

Performs the conversion.