Struct Registry 

pub struct Registry {
    pub specs: Vec<Found>,
    pub fix: Vec<FixFound>,
    pub dbc: Vec<DbcFound>,
    pub errors: Vec<SpecError>,
}

Every spec on the search path, first of each name first.

Fields

specs: Vec<Found>

fix: Vec<FixFound>

FIX dictionaries: QuickFIX XML files and kind = "fix" TOML files.

dbc: Vec<DbcFound>

DBC files for CAN logs: .dbc files and kind = "dbc" TOML files, in the order they are read.

errors: Vec<SpecError>

Spec files that could not be read, each with why.

Implementations

impl Registry

pub fn load(path: &[PathBuf]) -> Self

Read every spec on path. A directory gives its *.toml files in name order; a file gives itself. What cannot be read is kept as an error, not fatal. A TOML file of kind = "fix", or a QuickFIX XML file, is a FIX dictionary; a .dbc file, or a TOML file of kind = "dbc", is a DBC file.

pub fn fix_dict(&self, name: &str) -> Option<&Arc<Dictionary>>

The FIX dictionary named name.

pub fn of(specs: Vec<Spec>) -> Self

The registry of specs, for tests and hosts that have their specs in hand.

pub fn get(&self, name: &str) -> Option<&Arc<Spec>>

pub fn is_empty(&self) -> bool

pub fn variants_of(&self, file: &Path) -> Option<Arc<Spec>>

The spec that reads the file file, by its glob or else by its magic as an open picks it, when it reads the file’s records as several variants: the home screen lists them inside the file. Its first bytes are read only when no glob names it.

pub fn listed(&self, path: &Path, head: &[u8], whole: bool) -> Option<Arc<Spec>>

The spec that reads a local file a listing looked inside, as an open with nothing asked picks it: by glob, else by magic and match.where, compared against head, the bytes the listing already read from its front (all of it when whole). A spec whose match needs more than head holds is not asked.

pub fn by_glob(&self, path: &Path, is_dir: bool) -> Vec<Arc<Spec>>

The specs whose globs match path, a file or (for the columns layout) a directory, by name alone.

pub fn matching( &self, path: &Path, is_dir: bool, head: impl FnOnce(u64) -> Option<Vec<u8>>, ) -> Option<Matched>

The specs path matches: by glob, else by magic. A spec with match.where matches only a file whose header holds those values. The front of the file is read through head, once, and only when a magic or a header is to be compared.

pub fn matching_among( &self, path: &Path, is_dir: bool, wanted: impl Fn(&Spec) -> bool, head: impl FnOnce(u64) -> Option<Vec<u8>>, ) -> Option<Matched>

Self::matching among the specs wanted says may read path.

pub fn listing(&self, path: &[PathBuf]) -> String

Text for datui formats: each spec, the file it came from, the copies it hides, and the spec files that could not be read.

Trait Implementations

impl Clone for Registry

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 Registry

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

Formats the value using the given formatter.

impl Default for Registry

fn default() -> Self

Returns the “default value” for a type.