Struct Spec 

pub struct Spec {

    pub name: String,
    pub description: Option<String>,
    pub documentation: Option<String>,
    pub notes: Vec<(String, ColumnNote)>,
    pub path: Option<PathBuf>,
    pub globs: Vec<String>,
    pub magic: Vec<u8>,
    pub magic_offset: u64,
    pub expect: Vec<(String, Expected)>,
    pub endian: Endian,
    pub endian_auto: bool,
    pub layout: Layout,
    pub header: Header,
    pub records: Records,
    pub delimited: Option<Arc<Delimited>>,
    pub footer: Option<Footer>,
    pub blocks: Option<Blocks>,
    pub capture: Option<Capture>,
    pub files: Option<Files>,
    pub sections: Vec<Section>,
    pub variant: Option<String>,
    /* private fields */
}

One format, as its spec describes it.

Fields

name: String

description: Option<String>

documentation: Option<String>

An https:// link to the format’s own documentation.

notes: Vec<(String, ColumnNote)>

A delimited spec’s [columns] notes: what each column of the file means.

path: Option<PathBuf>

The file it was read from.

globs: Vec<String>

magic: Vec<u8>

magic_offset: u64

expect: Vec<(String, Expected)>

Header fields and the values a file must hold in them to match.

endian: Endian

endian_auto: bool

The byte order is the one the magic reads in: as written, little-endian, and reversed, big-endian.

layout: Layout

header: Header

records: Records

delimited: Option<Arc<Delimited>>

For kind = "delimited": the reading options of a CSV-like file. A delimited spec has no header or record fields.

footer: Option<Footer>

blocks: Option<Blocks>

capture: Option<Capture>

files: Option<Files>

sections: Vec<Section>

variant: Option<String>

The variant read alone (--table), when one is.

Implementations

impl Spec

pub fn parse(text: &str, path: Option<&Path>) -> Result<Self, SpecError>

Read a spec from its text. path names it in errors.

pub fn is_delimited(&self) -> bool

Whether the spec is kind = "delimited".

pub fn load(path: &Path) -> Result<Self, SpecError>

Read the spec in path, which may be no more than MAX_SPEC_BYTES.

pub fn from_bytes(bytes: &[u8], from: &Path) -> Result<Self, SpecError>

The spec in bytes, read from from (a file or a URL), refused past MAX_SPEC_BYTES.

pub fn glob_matches(&self, path: &Path) -> bool

Whether path’s name matches one of the spec’s globs. A glob with a / is matched against the whole path, one without against the name.

pub fn magic_matches(&self, head: &[u8]) -> bool

Whether head, the first bytes of a file, carries the spec’s magic. A delimited spec’s magic is the start of the first line, after any byte-order mark.

pub fn header_matches(&self, head: &[u8]) -> bool

Whether head holds the header values match.where asks for.

pub fn match_reach(&self) -> u64

Bytes from the front of a file that settle the spec’s magic and where.

pub fn match_chips(&self) -> Vec<MatchChip>

What the spec says files of it look like, one chip per condition: its magic, its header values, then its globs. Empty when only --format picks it.

pub fn match_chips_for(&self, path: &Path) -> Vec<MatchChip>

The chips that named path on the home screen: the glob alone when it names the file, since a listing names a file by its glob without reading its header; else the magic and the header values it was checked against. All of them when neither does.

pub fn match_chips_chosen(&self, by: Chosen) -> Vec<MatchChip>

The chips of the rule that chose the spec: Chosen::Glob or Chosen::Magic leave the other out; any other choice keeps every chip.

pub fn lists_variants(&self) -> bool

Whether the spec reads a file’s records as several variants, each listed as a table inside the file.

pub fn static_columns(&self) -> Option<Vec<(String, DataType)>>

The columns a file of the spec opens with, when the spec alone says them: fixed records of one file whose fields take nothing from the file (no sizes, symbols or dates from its header). None when the open has to read the file to know.

impl Spec

pub fn docs(&self) -> Option<SpecDocs>

What the spec documents, or None when it says nothing beyond how to read: no description or link, no record type described, no column noted.

impl Spec

pub fn open_rows( &self, bytes: Arc<Bytes>, named: &str, ) -> Result<Opened, String>

Read bytes, one file of the rows layout, named named in what it says.

pub fn for_file(&self, head: &[u8]) -> Cow<'_, Spec>

The spec with its byte order settled by head, for endian = "auto": as the spec says when the magic reads as written, big-endian when it reads reversed.

pub fn reads_directory(&self) -> bool

Whether the spec reads a directory: column files, or a tree of its files.

pub fn with_variant(&self, name: &str) -> Result<Spec, String>

The spec reading the variant name alone: only its records, and only its columns.

pub fn open_rows_in( &self, bytes: Arc<Bytes>, named: &str, path: Option<&Path>, ) -> Result<Opened, String>

Read bytes, one file, named named in what it says; a symbol list a field names is looked for beside path, the file the bytes are, which also keeps the walk of its records for the next open of it.

pub fn open_columns(&self, dir: &Path) -> Result<Opened, String>

Read dir, a directory of one file per record field.

pub fn open(&self, path: &Path, named: &str) -> Result<Opened, String>

Open path: a file, or a directory of column files or of the spec’s files.

Trait Implementations

impl Clone for Spec

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 Spec

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

Formats the value using the given formatter.

impl PartialEq for Spec

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

Equality operator ==.

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

Inequality operator !=.