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

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 InputAnnotation