Trait charts::filter::gen::FilterGenExt

pub trait FilterGenExt {
    type Params: Default;

    const KEY: &'static str;
    const FMT: Option<&'static str>;

    fn parse_args(parser: Option<Parser<'_>>) -> Option<FilterGen>;
    fn add_help(s: &mut String);
    fn work(data: &Data, params: Self::Params) -> Res<(Filters, Vec<Chart>)>;
}

Trait implemented by filter generation techniques.

This trait represents the info needed by FilterGen to

• parse_args, KEY: parse the arguments of the --filter_gen flag,
• add_help: generate the part of the help message for --filter_gen specific to this filter generator,
• KEY, FMT: generate relevant error messages during CLAP, and
• work actually run the generator.

Required Associated Types

type Params: Default

Type of the parameters of the filter generator.

Required Associated Constants

const KEY: &'static str

CLAP key activating this generator.

const FMT: Option<&'static str>

Optional parameter format, should be a list of comma-separated <id>: <value> bindings.

Required Methods

fn parse_args(parser: Option<Parser<'_>>) -> Option<FilterGen>

Parses the (potentialy optional) parameters for the generator.

Simply returns None if parameters are ill-formed. Caller’s responsible for error reporting.

fn add_help(s: &mut String)

Adds help about itself to a String.

See AllocSite’s implementation of this function to get an idea of the format.

fn work(data: &Data, params: Self::Params) -> Res<(Filters, Vec<Chart>)>

Runs the generator on some data given some parameters.

Implementors

impl FilterGenExt for AllocSite

type Params = AllocSiteParams

const KEY: &'static str = "alloc_site"

const FMT: Option<&'static str> = _

impl FilterGenExt for Inactive

type Params = ()

const KEY: &'static str = "none"

const FMT: Option<&'static str> = None