bookclerk_library::entities::intake_items

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

Last updated View as Markdown

SeaORM entity for intake_items: one item seen in a drop folder and how far its ingest has come.

Item Kind Summary
Model struct Row shape for this table (DeriveEntityModel).
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 plugin_instance_id: String,
    pub item_hash: String,
    pub item_key: String,
    pub state: String,
    pub signature: String,
    pub quiet_since_ms: i64,
    pub batch_id: Option<String>,
    pub error: Option<String>,
    pub updated_at: String,
}

Row shape for this table (DeriveEntityModel).

Fields

  • plugin_instance_id: The drop folder: a storage plugin instance with the intake role.
  • item_hash: Lowercase hex SHA-256 of item_key.
  • item_key: The item's path relative to the folder root: its top-level name, or <patron folder>/<name> in subfolder mode.
  • state: settling, queued, done or failed.
  • signature: The item's signature as 64 hex characters.
  • quiet_since_ms: Unix milliseconds since which signature has not changed.
  • batch_id: The ingest batch the item was handed to, once queued.
  • error: Why the last ingest failed, bounded; None otherwise.
  • updated_at: RFC 3339 time of the last write.

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 plugin_instance_id: ActiveValue<String>,
    pub item_hash: ActiveValue<String>,
    pub item_key: ActiveValue<String>,
    pub state: ActiveValue<String>,
    pub signature: ActiveValue<String>,
    pub quiet_since_ms: ActiveValue<i64>,
    pub batch_id: ActiveValue<Option<String>>,
    pub error: ActiveValue<Option<String>>,
    pub updated_at: ActiveValue<String>,
}

Generated by sea-orm-macros

Fields

  • plugin_instance_id: Generated by sea-orm-macros
  • item_hash: Generated by sea-orm-macros
  • item_key: Generated by sea-orm-macros
  • state: Generated by sea-orm-macros
  • signature: Generated by sea-orm-macros
  • quiet_since_ms: Generated by sea-orm-macros
  • batch_id: Generated by sea-orm-macros
  • error: 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 {
    PluginInstanceId,
    ItemHash,
    ItemKey,
    State,
    Signature,
    QuietSinceMs,
    BatchId,
    Error,
    UpdatedAt,
}

Generated by sea-orm-macros

Variants

  • PluginInstanceId: Generated by sea-orm-macros
  • ItemHash: Generated by sea-orm-macros
  • ItemKey: Generated by sea-orm-macros
  • State: Generated by sea-orm-macros
  • Signature: Generated by sea-orm-macros
  • QuietSinceMs: Generated by sea-orm-macros
  • BatchId: Generated by sea-orm-macros
  • Error: Generated by sea-orm-macros
  • UpdatedAt: Generated by sea-orm-macros

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

PrimaryKey

pub enum PrimaryKey {
    PluginInstanceId,
    ItemHash,
}

Generated by sea-orm-macros

Variants

  • PluginInstanceId: Generated by sea-orm-macros
  • ItemHash: 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