Struct lib::models::annotation::AnnotationMetadata

pub struct AnnotationMetadata {
    pub id: String,
    pub book_id: String,
    pub created: DateTimeUtc,
    pub modified: DateTimeUtc,
    pub location: String,
    pub epubcfi: String,
}

A struct representing an annotation’s metadata.

This is all the data that is not directly editable by the user.

Fields

id: String

The annotation’s unique id.

book_id: String

The book id this annotation belongs to.

created: DateTimeUtc

The date the annotation was created.

modified: DateTimeUtc

The date the annotation was last modified.

location: String

A location string used for sorting annotations into their order of appearance inside their respective book. This string is generated from the annotation’s epubcfi.

epubcfi: String

The annotation’s raw epubcfi.

Implementations

impl AnnotationMetadata

pub fn slug_created(&self) -> String

Returns a slugified string of the creation date.

Examples found in repository

src/lib/models/annotation.rs (line 186)

    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        #[derive(Serialize)]
        struct _Slugs {
            created: String,
            modified: String,
        }

        #[derive(Serialize)]
        struct _AnnotationMetadata<'a> {
            id: &'a str,
            book_id: &'a str,
            created: &'a DateTimeUtc,
            modified: &'a DateTimeUtc,
            location: &'a str,
            epubcfi: &'a str,
            slugs: _Slugs,
        }

        let metadata = _AnnotationMetadata {
            id: &self.id,
            book_id: &self.book_id,
            created: &self.created,
            modified: &self.modified,
            location: &self.location,
            epubcfi: &self.epubcfi,
            slugs: _Slugs {
                created: self.slug_created(),
                modified: self.slug_modified(),
            },
        };

        metadata.serialize(serializer)
    }

pub fn slug_modified(&self) -> String

Returns a slugified string of the modification date.

Examples found in repository

src/lib/models/annotation.rs (line 187)

    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        #[derive(Serialize)]
        struct _Slugs {
            created: String,
            modified: String,
        }

        #[derive(Serialize)]
        struct _AnnotationMetadata<'a> {
            id: &'a str,
            book_id: &'a str,
            created: &'a DateTimeUtc,
            modified: &'a DateTimeUtc,
            location: &'a str,
            epubcfi: &'a str,
            slugs: _Slugs,
        }

        let metadata = _AnnotationMetadata {
            id: &self.id,
            book_id: &self.book_id,
            created: &self.created,
            modified: &self.modified,
            location: &self.location,
            epubcfi: &self.epubcfi,
            slugs: _Slugs {
                created: self.slug_created(),
                modified: self.slug_modified(),
            },
        };

        metadata.serialize(serializer)
    }

Trait Implementations

impl Clone for AnnotationMetadata

fn clone(&self) -> AnnotationMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnnotationMetadata

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

Formats the value using the given formatter.

impl Default for AnnotationMetadata

fn default() -> AnnotationMetadata

Returns the “default value” for a type.

impl Ord for AnnotationMetadata

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<AnnotationMetadata> for AnnotationMetadata

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<AnnotationMetadata> for AnnotationMetadata

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 AnnotationMetadata

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 AnnotationMetadata

impl StructuralEq for AnnotationMetadata