Struct Collection 

pub struct Collection {
    pub name: String,
    pub cover_art: Option<ImageArt>,
    pub items: CollectionType,
    /* private fields */
}

Fields

name: String

cover_art: Option<ImageArt>

items: CollectionType

Implementations

impl Collection

pub fn db_find_by_name( name: impl AsRef<str>, ) -> Result<Option<Self>, DatabaseError>

where Self: 'static,

impl Collection

pub fn collectables( self, db: &LibraryDb, ) -> Result<Vec<Collectable>, DatabaseError>

Trait Implementations

impl Clone for Collection

fn clone(&self) -> Collection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Createable for Collection

type CreateArgs = CollectionCreateArgs

type Err = Infallible

fn tx_create( cas_tx: &mut CompareAndSwapTransaction<Self::EntryDb>, args: Self::CreateArgs, ) -> Result<Self, CustomTransactionError<Self::Err>>

Creates a new Self in the database using Self::CreateArgs

impl DatabaseEntry for Collection

const VERSION_NUMBER: u32 = 1

The current version number of the struct, used for updating

type Id = CollectionId

type EntryDb = LibraryDb

fn tree(db: &Self::EntryDb) -> Tree

Returns the tree that self belongs to

fn id(&self) -> Self::Id

Returns the ID that represents self

fn read_only(&self) -> bool

This function is called before a value is upserted, if it returns true, an error will be returned from the transaction.

fn db_check(id: Self::Id) -> Result<bool, DatabaseError>

Checks if an item exists in the database as lightly as possible

fn db_get_from( id: Self::Id, db: &Self::EntryDb, ) -> Result<Option<Self>, DatabaseError>

Gets the entry of Self with the given id from the input db

fn db_get(id: Self::Id) -> Result<Option<Self>, DatabaseError>

Gets the entry of Self with the given id

fn db_get_all_from(db: &Self::EntryDb) -> Result<Vec<Self>, DatabaseError>

Gets all entries of Self in from the input db

fn db_get_all() -> Result<Vec<Self>, DatabaseError>

Gets all entries of Self in the database

fn db_get_batch_from<I, A>( ids: I, db: &Self::EntryDb, ) -> Result<Vec<Self>, DatabaseError>

where I: IntoIterator<Item = A>, A: Borrow<Self::Id>,

Gets all entries of Self in the database with the matching ids from the input db

fn db_get_batch<I, A>(ids: I) -> Result<Vec<Self>, DatabaseError>

where I: IntoIterator<Item = A>, A: Borrow<Self::Id>,

Gets all entries of Self in the database with the matching ids

fn pre_upsert( &mut self, _cas_tx: &CompareAndSwapTransaction<Self::EntryDb>, ) -> Result<(), TransactionError>

This function is called before a value is upserted, allowing you to make last moment changes before its upserted into the database, like field sorting

fn db_upsert(&self) -> Result<(), TransactionError>

Wrapper around db_transaction() which upserts the item using CompareAndSwapTransaction::tx_upsert()

impl Debug for Collection

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Collection

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Collection

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.