Struct wallabag_api::types::Annotation

pub struct Annotation {
    pub id: ID,
    pub annotator_schema_version: String,
    pub created_at: DateTime<Utc>,
    pub quote: Option<String>,
    pub ranges: Vec<Range>,
    pub text: String,
    pub updated_at: DateTime<Utc>,
    pub user: Option<String>,
}

Represents an annotation as returned from the API.

Annotations are in Annotatorjs format. https://annotatorjs.org/ See http://docs.annotatorjs.org/en/v1.2.x/annotation-format.html for documentation on the format.

Fields

id: ID

The unique integral id of the annotation.

annotator_schema_version: String

A schema version to presumably support updates in the future. Currently all annotations appear to be v1.0. Hopefully this isn't going to get breaking changes any time soon.

created_at: DateTime<Utc>

When the annotation was created on the server.

quote: Option<String>

The quoted (or highlighted) text from the entry.

ranges: Vec<Range>

A list of ranges from the entry that the annotation covers. Most annotations cover a single range.

text: String

The content of the annotation - any text the user added to annotate the entry.

updated_at: DateTime<Utc>

Timestamp of when the annotation was last updated. This is independent of the associated entry.

user: Option<String>

Possibly part of wallabag planning on supporting sharing between users. Currently this field is always None.

Trait Implementations

impl From<Annotation> for ID

This is implemented so that an Annotation can be used interchangeably with an ID for some client methods. For convenience.

fn from(ann: Annotation) -> Self

Performs the conversion.

impl<'_> From<&'_ Annotation> for ID

This is implemented so that an &Annotation can be used interchangeably with an ID for some client methods. For convenience.

fn from(ann: &Annotation) -> Self

Performs the conversion.

impl Debug for Annotation

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

Formats the value using the given formatter.

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<'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.