Struct gooseberry::gooseberry::cli::Filters

pub struct Filters {
    pub from: Option<DateTime<Utc>>,
    pub before: Option<DateTime<Utc>>,
    pub include_updated: bool,
    pub uri: String,
    pub any: String,
    pub tags: Vec<String>,
}

CLI options for filtering annotations

Fields

from: Option<DateTime<Utc>>

Only annotations created after this date and time Can be colloquial, e.g. "last Friday 8pm"

before: Option<DateTime<Utc>>

Only annotations created before this date and time Can be colloquial, e.g. "last Friday 8pm"

include_updated: bool

If true, includes annotations updated after --from or before --before (instead of just created)

uri: String

Only annotations with this pattern in their URL Doesn't have to be the full URL, e.g. "wikipedia"

any: String

Only annotations with this pattern in their quote, tags, text, or uri

tags: Vec<String>

Only annotations with these tags

Trait Implementations

impl Debug for Filters

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

Formats the value using the given formatter.

impl Default for Filters

pub fn default() -> Filters

Returns the "default value" for a type.

impl StructOpt for Filters

pub fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

pub fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It's guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

pub fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

pub fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

pub fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

pub fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.

impl StructOptInternal for Filters

pub fn augment_clap<'a, 'b>(app: App<'a, 'b>) -> App<'a, 'b>

pub fn is_subcommand() -> bool

pub fn from_subcommand(
    _sub: (&'b str, Option<&'b ArgMatches<'a>>)
) -> Option<Self>