Enum hypothesis::cli::AnnotationsCommand

pub enum AnnotationsCommand {
    Create {
        annotation: InputAnnotation,
        file: Option<PathBuf>,
    },
    Update {
        id: String,
        annotation: InputAnnotation,
        file: Option<PathBuf>,
    },
    Search {
        query: SearchQuery,
        file: Option<PathBuf>,
    },
    Fetch {
        id: String,
        file: Option<PathBuf>,
    },
    Delete {
        id: String,
    },
    Flag {
        id: String,
    },
    Hide {
        id: String,
    },
    Show {
        id: String,
    },
}

Variants

Create

Create a new annotation (TODO: add Target somehow)

Fields of Create

annotation: InputAnnotationfile: Option<PathBuf>

write created annotation to this file in JSON format

Update

Update an existing annotation

Fields of Update

id: String

unique ID of the annotation to update

annotation: InputAnnotationfile: Option<PathBuf>

write updated annotation to this file in JSON format

Search

Search for annotations with optional filters

Fields of Search

query: SearchQueryfile: Option<PathBuf>

json file to write search results to, writes to stdout if not given

Fetch

Fetch annotation by ID

Fields of Fetch

id: String

unique ID of the annotation to fetch

file: Option<PathBuf>

json file to write annotation to, writes to stdout if not given

Delete

Delete annotation by ID

Fields of Delete

id: String

unique ID of the annotation to delete

Flag

Flag an annotation

Flag an annotation for review (moderation). The moderator of the group containing the annotation will be notified of the flag and can decide whether or not to hide the annotation. Note that flags persist and cannot be removed once they are set.

Fields of Flag

id: String

unique ID of the annotation to flag

Hide

Hide an annotation

Hide an annotation. The authenticated user needs to have the moderate permission for the group that contains the annotation — this permission is granted to the user who created the group.

Fields of Hide

id: String

unique ID of the annotation to hide

Show

Show an annotation

Show/“un-hide” an annotation. The authenticated user needs to have the moderate permission for the group that contains the annotation—this permission is granted to the user who created the group.

Fields of Show

id: String

unique ID of the annotation to show

Trait Implementations

impl Debug for AnnotationsCommand

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

Formats the value using the given formatter.

impl StructOpt for AnnotationsCommand

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

Returns clap::App corresponding to the struct.

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 AnnotationsCommand

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

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

fn is_subcommand() -> bool