bookclerk_library::entities::plugin_kv

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

Last updated View as Markdown

SeaORM entity for the per-plugin durable key/value table plugin_kv.

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_key: String,
    pub namespace: String,
    pub key: String,
    pub value: String,
    pub metadata: String,
    pub expires_at: String,
    pub updated_at: String,
}

Row shape for this table (DeriveEntityModel).

Fields

  • plugin_key: Owning plugin PluginKey (canonical text).
  • namespace: Namespace a [[kv_namespaces]] row names.
  • key: Key within the namespace.
  • value: Value bytes stored as base64 text (portable across backends).
  • metadata: Opaque JSON metadata text; empty when none.
  • expires_at: RFC 3339 expiry; empty when the key never expires.
  • 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_key: ActiveValue<String>,
    pub namespace: ActiveValue<String>,
    pub key: ActiveValue<String>,
    pub value: ActiveValue<String>,
    pub metadata: ActiveValue<String>,
    pub expires_at: ActiveValue<String>,
    pub updated_at: ActiveValue<String>,
}

Generated by sea-orm-macros

Fields

  • plugin_key: Generated by sea-orm-macros
  • namespace: Generated by sea-orm-macros
  • key: Generated by sea-orm-macros
  • value: Generated by sea-orm-macros
  • metadata: Generated by sea-orm-macros
  • expires_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 {
    PluginKey,
    Namespace,
    Key,
    Value,
    Metadata,
    ExpiresAt,
    UpdatedAt,
}

Generated by sea-orm-macros

Variants

  • PluginKey: Generated by sea-orm-macros
  • Namespace: Generated by sea-orm-macros
  • Key: Generated by sea-orm-macros
  • Value: Generated by sea-orm-macros
  • Metadata: Generated by sea-orm-macros
  • ExpiresAt: Generated by sea-orm-macros
  • UpdatedAt: Generated by sea-orm-macros

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

PrimaryKey

pub enum PrimaryKey {
    PluginKey,
    Namespace,
    Key,
}

Generated by sea-orm-macros

Variants

  • PluginKey: Generated by sea-orm-macros
  • Namespace: Generated by sea-orm-macros
  • Key: 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