Struct Annotation 

pub struct Annotation {
    pub id: String,
    pub annotation_type: AnnotationType,
    pub anchor: ContentAnchor,
    pub author: String,
    pub created: String,
    pub content: String,
}

Available on crate feature signatures only.

A core annotation.

Core annotations are simpler than collaboration comments - they use a plain string author field instead of the full Collaborator object, and don’t support threading, suggestions, or reactions.

Fields

id: String

Unique annotation identifier.

annotation_type: AnnotationType

Annotation type.

anchor: ContentAnchor

Anchor to document content.

author: String

Author name or identifier.

created: String

ISO 8601 creation timestamp.

content: String

Annotation content (text).

Implementations

impl Annotation

pub fn new( id: impl Into<String>, annotation_type: AnnotationType, anchor: ContentAnchor, author: impl Into<String>, content: impl Into<String>, ) -> Self

Create a new annotation.

pub fn comment( id: impl Into<String>, anchor: ContentAnchor, author: impl Into<String>, content: impl Into<String>, ) -> Self

Create a comment annotation.

pub fn highlight( id: impl Into<String>, anchor: ContentAnchor, author: impl Into<String>, content: impl Into<String>, ) -> Self

Create a highlight annotation.

pub fn note( id: impl Into<String>, anchor: ContentAnchor, author: impl Into<String>, content: impl Into<String>, ) -> Self

Create a note annotation.

pub fn reaction( id: impl Into<String>, anchor: ContentAnchor, author: impl Into<String>, emoji: impl Into<String>, ) -> Self

Create a reaction annotation.

pub fn with_created(self, created: impl Into<String>) -> Self

Set the creation timestamp.

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Annotation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Annotation

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Annotation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Annotation

impl StructuralPartialEq for Annotation