Struct hypothesis::annotations::SearchQuery

pub struct SearchQuery {

    pub limit: u8,
    pub sort: Sort,
    pub search_after: String,
    pub offset: usize,
    pub order: Order,
    pub uri: String,
    pub uri_parts: String,
    pub wildcard_uri: String,
    pub user: String,
    pub group: String,
    pub tag: String,
    pub tags: Vec<String>,
    pub any: String,
    pub quote: String,
    pub references: String,
    pub text: String,
}

Options to filter and sort search results. See the Hypothesis API docs for more details on using these fields

Fields

limit: u8

The maximum number of annotations to return.

Default: 20. Range: [ 0 .. 200 ]

sort: Sort

The field by which annotations should be sorted One of created, updated, id, group, user

Default: updated

search_after: String

Example: “2019-01-03T19:46:09.334Z”

Define a start point for a subset (page) of annotation search results. NOTE: make sure to set sort to Sort::Asc if using search_after

offset: usize

The number of initial annotations to skip in the result set.

Default: 0. Range: <= 9800. search_after is more efficient.

order: Order

The order in which the results should be sorted. One of asc, desc

Default: desc

uri: String

Limit the results to annotations matching the specific URI or equivalent URIs.

URI can be a URL (a web page address) or a URN representing another kind of resource such as DOI (Digital Object Identifier) or a PDF fingerprint.

uri_parts: String

Limit the results to annotations containing the given keyword (tokenized chunk) in the URI. The value must exactly match an individual URI keyword.

wildcard_uri: String

Limit the results to annotations whose URIs match the wildcard pattern.

user: String

Limit the results to annotations made by the specified user. (in the format acct:<username>@<authority>)

group: String

Limit the results to annotations made in the specified group (by group ID).

tag: String

Limit the results to annotations tagged with the specified value.

tags: Vec<String>

Similar to tag but allows a list of multiple tags.

any: String

Limit the results to annotations who contain the indicated keyword in any of the following fields: quote, tags, text, url

quote: String

Limit the results to annotations that contain this text inside the text that was annotated.

references: String

Returns annotations that are replies to this parent annotation ID.

text: String

Limit the results to annotations that contain this text in their textual body.

Implementations

impl SearchQuery

pub fn builder() -> SearchQueryBuilder

Trait Implementations

impl Clone for SearchQuery

fn clone(&self) -> SearchQuery

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchQuery

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

Formats the value using the given formatter.

impl Default for SearchQuery

fn default() -> SearchQuery

Returns the “default value” for a type.

impl PartialEq<SearchQuery> for SearchQuery

fn eq(&self, other: &SearchQuery) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SearchQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructOpt for SearchQuery

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.

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.

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.

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.

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 StructuralPartialEq for SearchQuery