bookclerk_library::entities::bookmarks

Development These docs follow the development version and change with every merge.

Last updated View as Markdown

SeaORM entity for bookmarks: places one person marked in one edition. Written by crate::LibraryStore's playback methods (store::playback).

Item Kind Summary
Model struct Row shape for one bookmark.
ColumnIter struct An iterator over the variants of [Column]
Entity struct Generated by sea-orm-macros
PrimaryKeyIter struct An iterator over the variants of [PrimaryKey]
ActiveModel struct Generated by sea-orm-macros
RelationIter struct An iterator over the variants of [Relation]
Column enum Generated by sea-orm-macros
PrimaryKey enum Generated by sea-orm-macros
Relation enum Declared SeaORM relations (none).

Structs

Model

pub struct Model {
    pub id: String,
    pub user_id: i64,
    pub edition_id: String,
    pub position_ms: i64,
    pub title: String,
    pub created_at: String,
    pub updated_at: String,
}

Row shape for one bookmark.

Fields

  • id: Bookmark id (hyphenated UUID).
  • user_id: The person who made it (users.id).
  • edition_id: The edition (editions.id) it marks a place in.
  • position_ms: The marked place, in milliseconds from the edition's start.
  • title: The person's note for it; may be empty.
  • created_at: RFC 3339 time it was made.
  • updated_at: RFC 3339 time of the last change.

Model::into_ex

pub fn into_ex(self) -> Self

Generated by sea-orm-macros

Implements: Clone, Debug, Eq, From<Model>, FromQueryResult, IntoActiveModel<ActiveModel>, ModelTrait, PartialEq, TryFrom<ActiveModel>, TryIntoModel<Model>

ColumnIter

pub struct ColumnIter {
    /* private fields */
}

An iterator over the variants of Column

Implements: Clone, Debug, DoubleEndedIterator, ExactSizeIterator, FusedIterator, Iterator

Entity

pub struct Entity;

Generated by sea-orm-macros

Implements: Clone, Copy, Debug, Default, EntityName, EntityTrait, Iden, IdenStatic

PrimaryKeyIter

pub struct PrimaryKeyIter {
    /* private fields */
}

An iterator over the variants of PrimaryKey

Implements: Clone, Debug, DoubleEndedIterator, ExactSizeIterator, FusedIterator, Iterator

ActiveModel

pub struct ActiveModel {
    pub id: ActiveValue<String>,
    pub user_id: ActiveValue<i64>,
    pub edition_id: ActiveValue<String>,
    pub position_ms: ActiveValue<i64>,
    pub title: ActiveValue<String>,
    pub created_at: ActiveValue<String>,
    pub updated_at: ActiveValue<String>,
}

Generated by sea-orm-macros

Fields

  • id: Generated by sea-orm-macros
  • user_id: Generated by sea-orm-macros
  • edition_id: Generated by sea-orm-macros
  • position_ms: Generated by sea-orm-macros
  • title: Generated by sea-orm-macros
  • created_at: Generated by sea-orm-macros
  • updated_at: Generated by sea-orm-macros

Implements: ActiveModelBehavior, ActiveModelTrait, Clone, Debug, Default, From<Model>, IntoActiveModel<ActiveModel>, PartialEq, TryFrom<ActiveModel>, TryIntoModel<Model>

RelationIter

pub struct RelationIter {
    /* private fields */
}

An iterator over the variants of Relation

Implements: Clone, Debug, DoubleEndedIterator, ExactSizeIterator, FusedIterator, Iterator

Enums

Column

pub enum Column {
    Id,
    UserId,
    EditionId,
    PositionMs,
    Title,
    CreatedAt,
    UpdatedAt,
}

Generated by sea-orm-macros

Variants

  • Id: Generated by sea-orm-macros
  • UserId: Generated by sea-orm-macros
  • EditionId: Generated by sea-orm-macros
  • PositionMs: Generated by sea-orm-macros
  • Title: Generated by sea-orm-macros
  • CreatedAt: Generated by sea-orm-macros
  • UpdatedAt: Generated by sea-orm-macros

Implements: Clone, ColumnTrait, Copy, Debug, FromStr, Iden, IdenStatic, IntoEnumIterator

PrimaryKey

pub enum PrimaryKey {
    Id,
}

Generated by sea-orm-macros

Variants

  • Id: Generated by sea-orm-macros

Implements: Clone, Copy, Debug, Iden, IdenStatic, IntoEnumIterator, PrimaryKeyToColumn, PrimaryKeyTrait

Relation

pub enum Relation {}

Declared SeaORM relations (none).

Implements: Clone, Copy, Debug, IntoEnumIterator, RelationTrait

Generated from crates/bookclerk-library at main · View as Markdown