Struct hypothesis::annotations::InputAnnotation

pub struct InputAnnotation {
    pub uri: String,
    pub text: String,
    pub tags: Option<Vec<String>>,
    pub document: Option<Document>,
    pub group: String,
    pub target: Target,
    pub references: Vec<String>,
}

Struct to create annotations

All fields except uri are optional, i.e. leave as default.

Example

use hypothesis::annotations::{InputAnnotation, Target, Selector};
// A simple annotation
let annotation_simple = InputAnnotation::builder()
    .uri("https://www.example.com")
    .text("My new annotation").build()?;

// A complex annotation
let annotation_complex = InputAnnotation::builder()
    .uri("https://www.example.com")
    .text("this is a comment")
    .target(Target::builder().source("https://www.example.com")
        .selector(vec![Selector::new_quote("exact text in website to highlight",
                                            "prefix of text",
                                            "suffix of text")]).build()?)
    .tags(vec!["tag1".into(), "tag2".into()])
    .build()?;

Fields

uri: String

URI that this annotation is attached to.

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.

text: String

Annotation text / comment given by user

This is NOT the selected text on the web-page

tags: Option<Vec<String>>

Tags attached to the annotation

document: Option<Document>

Further metadata about the target document

group: String

The unique identifier for the annotation’s group.

If an annotation is a reply to another annotation (see references), this field will be ignored — replies belong to the same group as their parent annotations.

target: Target

Which part of the document does the annotation target?

If left as default then the annotation is linked to the whole page.

references: Vec<String>

Annotation IDs for any annotations this annotation references (e.g. is a reply to)

Implementations

impl InputAnnotation

pub fn builder() -> InputAnnotationBuilder

Trait Implementations

impl Args for InputAnnotation

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

impl Clone for InputAnnotation

fn clone(&self) -> InputAnnotation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for InputAnnotation

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 InputAnnotation

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

Formats the value using the given formatter.

impl Default for InputAnnotation

fn default() -> InputAnnotation

Returns the “default value” for a type.

impl FromArgMatches for InputAnnotation

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( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for InputAnnotation

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 PartialEq for InputAnnotation

fn eq(&self, other: &InputAnnotation) -> 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 InputAnnotation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InputAnnotation