Struct InputAnnotationBuilder 

pub struct InputAnnotationBuilder { /* private fields */ }

Builder for InputAnnotation.

Implementations

impl InputAnnotationBuilder

pub fn uri<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn text<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Annotation text / comment given by user

This is NOT the selected text on the web-page

pub fn tags(&mut self, value: Vec<String>) -> &mut Self

Tags attached to the annotation

pub fn document(&mut self, value: Document) -> &mut Self

Further metadata about the target document

pub fn group<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn target(&mut self, value: Target) -> &mut Self

Which part of the document does the annotation target?

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

pub fn references(&mut self, value: Vec<String>) -> &mut Self

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

pub fn builder(&self) -> Result<InputAnnotation, InputAnnotationBuilderError>

Builds a new InputAnnotation.

Errors

If a required field has not been initialized.

impl InputAnnotationBuilder

pub fn build(&self) -> Result<InputAnnotation, HypothesisError>

Builds a new InputAnnotation.

Trait Implementations

impl Clone for InputAnnotationBuilder

fn clone(&self) -> InputAnnotationBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for InputAnnotationBuilder

fn default() -> Self

Returns the “default value” for a type.