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

annotation: InputAnnotation

file: Option<PathBuf>

write created annotation to this file in JSON format

Update

Update an existing annotation

Fields

id: String

unique ID of the annotation to update

annotation: InputAnnotation

file: Option<PathBuf>

write updated annotation to this file in JSON format

Search

Search for annotations with optional filters

Fields

query: SearchQuery

file: Option<PathBuf>

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

Fetch

Fetch annotation by ID

Fields

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

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

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

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

id: String

unique ID of the annotation to show

Trait Implementations

impl CommandFactory for AnnotationsCommand

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for AnnotationsCommand

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

Formats the value using the given formatter.

impl FromArgMatches for AnnotationsCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for AnnotationsCommand

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Subcommand for AnnotationsCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self.

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand