Enum FormatChoice 

pub enum FormatChoice {
    Builtin(FileFormat),
    Spec(String),
    File(PathBuf),
}

What --format names: a format datui reads, a format spec on the search path, or a spec’s file.

Variants

Builtin(FileFormat)

Spec(String)

A spec on the search path, by its namespaced name.

File(PathBuf)

A spec’s file: ./acme.toml.

Implementations

impl FormatChoice

pub fn builtin(&self) -> Option<FileFormat>

The built-in format, when that is what was named.

pub fn read_mode(&self, stored: Stored) -> Option<ReadMode>

How a file read this way is read when opened: a built-in format’s FileFormat::read_mode, or a spec’s, whose records are decoded from a map of the file (or of its decompressed copy) only where they are shown.

pub fn bucket_object(&self, stored: Stored) -> RemoteRead

How one object read this way in a bucket is read. A spec reads local files, so a spec’s object is downloaded first.

pub fn http_file(&self) -> RemoteRead

How one HTTP(S) file read this way is read; a spec’s is downloaded first.

pub fn bucket_prefix(&self, stored: Stored) -> Option<RemoteRead>

How a bucket prefix read this way is read as one table; a spec’s is not.

pub fn spec(&self) -> Option<&str>

The spec’s name, when a spec was named.

pub fn spec_file(&self) -> Option<&Path>

The spec’s file, when a file was named.

Trait Implementations

impl Clone for FormatChoice

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FormatChoice

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

Formats the value using the given formatter.

impl Eq for FormatChoice

impl PartialEq for FormatChoice

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FormatChoice