Struct lib::models::annotation::Annotation

pub struct Annotation {
    pub body: String,
    pub style: String,
    pub notes: String,
    pub tags: BTreeSet<String>,
    pub metadata: AnnotationMetadata,
}

A struct representing an annotation and its metadata.

Fields

body: String

The body of the annotation.

style: String

The annotation’s highlight style.

Possible values are: green, blue, yellow, pink purple or underline.

notes: String

The annotation’s notes.

tags: BTreeSet<String>

The annotation’s #tags.

metadata: AnnotationMetadata

The annotation’s metadata.

Trait Implementations

impl ABQuery for Annotation

const DATABASE_NAME: ABDatabaseName = ABDatabaseName::Annotations

The database’s name being either BKLibrary or AEAnnotation.

const QUERY: &'static str = { "SELECT\n ZANNOTATIONSELECTEDTEXT, -- 0 body\n ZANNOTATIONNOTE, -- 1 notes\n ZANNOTATIONSTYLE, -- 2 style\n ZANNOTATIONUUID, -- 3 id\n ZAEANNOTATION.ZANNOTATIONASSETID, -- 4 book_id\n ZANNOTATIONCREATIONDATE, -- 5 created\n ZANNOTATIONMODIFICATIONDATE, -- 6 modified\n ZANNOTATIONLOCATION -- 7 location\n FROM ZAEANNOTATION\n WHERE ZANNOTATIONSELECTEDTEXT IS NOT NULL\n AND ZANNOTATIONDELETED = 0\n ORDER BY ZANNOTATIONASSETID;" }

The query to retrieve rows that are subsequently passed into ABQuery::from_row() to create instances of the implemented type.

fn from_row(row: &Row<'_>) -> Self

Constructs an instance of the respective type from a Row.

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a copy 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 Default for Annotation

fn default() -> Annotation

Returns the “default value” for a type.

impl<'a> From<&'a Annotation> for AnnotationContext<'a>

fn from(annotation: &'a Annotation) -> Self

Converts to this type from the input type.

impl Ord for Annotation

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Annotation> for Annotation

fn eq(&self, other: &Self) -> 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 PartialOrd<Annotation> for Annotation

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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 StructuralEq for Annotation