Enum hypothesis::cli::GroupsCommand

pub enum GroupsCommand {
    List {
        filters: GroupFilters,
        file: Option<PathBuf>,
    },
    Create {
        name: String,
        description: Option<String>,
        file: Option<PathBuf>,
    },
    Fetch {
        id: String,
        expand: Vec<Expand>,
        file: Option<PathBuf>,
    },
    Update {
        id: String,
        name: Option<String>,
        description: Option<String>,
        file: Option<PathBuf>,
    },
    Members {
        id: String,
        file: Option<PathBuf>,
    },
    Leave {
        id: String,
    },
}

Variants

List

Retrieve a list of applicable Groups, filtered by authority and target document (document_uri). Also retrieve user’s private Groups.

Fields of List

filters: GroupFiltersfile: Option<PathBuf>

json file to write filtered groups to, writes to stdout if not given

Create

Create a new, private group for the currently-authenticated user.

Fields of Create

name: String

group name

description: Option<String>

group description

file: Option<PathBuf>

write created group to this file in JSON format

Fetch

Fetch a single Group resource.

Fields of Fetch

id: String

unique Group ID

expand: Vec<Expand>

Expand the organization, scope, or both

file: Option<PathBuf>

write group to this file in JSON format

Update

Update a Group resource.

Fields of Update

id: String

unique Group ID

name: Option<String>

new group name

description: Option<String>

new group description

file: Option<PathBuf>

write updated group to this file in JSON format

Members

Fetch a list of all members (users) in a group.

Returned user resource only contains public-facing user data. Authenticated user must have read access to the group. Does not require authentication for reading members of public groups. Returned members are unsorted.

Fields of Members

id: String

unique Group ID

file: Option<PathBuf>

json file to write groups members to, writes to stdout if not given

Leave

Remove yourself from a group.

Fields of Leave

id: String

Trait Implementations

impl Debug for GroupsCommand

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

Formats the value using the given formatter.

impl StructOpt for GroupsCommand

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 GroupsCommand

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