Struct SpecData 

pub struct SpecData<S> {

    pub summary: S,
    pub description: S,
    pub availability: S,
    pub license_details: S,
    pub repo_url: Option<S>,
    pub home_url: Option<S>,
    pub docs_url: Option<S>,
    pub input_params_url: Option<S>,
    pub examples_url: Option<S>,
    pub paper_url: Option<S>,
    pub license: License,
    pub license_url: Option<S>,
    pub tested: bool,
}

Tool-specific descriptive data which does not depend on a UI framework or execution environment or on the tool’s identity (slug/name), so that the same field list can also back the catalog’s &'static str-based static data – see tool_definitions::catalog::CatalogEntry::spec.

Fields

summary: S

Terser than Summary. May also include copy+paste+modify from an tool-official source.

description: S

Note: This may be taken directly (Copy + paste, or modified) directly from the tool’s official website, docs, or paper. It may include a degree of marketing copy, but we try to make it descriptive if that’s too heavy.

availability: S

license_details: S

repo_url: Option<S>

home_url: Option<S>

docs_url: Option<S>

input_params_url: Option<S>

Documentation for the tool’s input parameters.

examples_url: Option<S>

Official examples of use

paper_url: Option<S>

license: License

license_url: Option<S>

A tool-specific license page, used when license is License::Other (or any other variant without a fixed License::official_url).

tested: bool

Tested, compared inputs and outputs against official docs if available, and had results evaluated in at least some cases, e.g. official examples.

Implementations

impl SpecData<&'static str>

pub fn to_owned_data(&self) -> SpecData<String>

Copy this static catalog data into an owned, runtime-facing form.

Trait Implementations

impl<S: Clone> Clone for SpecData<S>

fn clone(&self) -> SpecData<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Copy> Copy for SpecData<S>

impl<S: Debug> Debug for SpecData<S>

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

Formats the value using the given formatter.

impl<S: Eq> Eq for SpecData<S>

impl<S: PartialEq> PartialEq for SpecData<S>

fn eq(&self, other: &SpecData<S>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<S: PartialEq> StructuralPartialEq for SpecData<S>