Struct Collection

pub struct Collection {
    pub id: CollectionId,
    pub name: String,
    pub runtime: Duration,
    pub song_count: usize,
}

Fields

id: CollectionId

the unique identifier for this Collection.

name: String

The name of the collection.

runtime: Duration

Total runtime.

song_count: usize

the number of songs this collection has.

Implementations

impl Collection

pub async fn create<C: Connection>( db: &Surreal<C>, collection: Self, ) -> StorageResult<Option<Self>>

pub async fn read_all<C: Connection>( db: &Surreal<C>, ) -> StorageResult<Vec<Self>>

pub async fn read<C: Connection>( db: &Surreal<C>, id: CollectionId, ) -> StorageResult<Option<Self>>

pub async fn update<C: Connection>( db: &Surreal<C>, id: CollectionId, changes: CollectionChangeSet, ) -> StorageResult<Option<Self>>

pub async fn delete<C: Connection>( db: &Surreal<C>, id: CollectionId, ) -> StorageResult<Option<Self>>

pub async fn add_songs<C: Connection>( db: &Surreal<C>, id: CollectionId, song_ids: Vec<SongId>, ) -> StorageResult<()>

pub async fn read_songs<C: Connection>( db: &Surreal<C>, id: CollectionId, ) -> StorageResult<Vec<Song>>

pub async fn remove_songs<C: Connection>( db: &Surreal<C>, id: CollectionId, song_ids: Vec<SongId>, ) -> StorageResult<bool>

removes songs from a collection

Returns

• bool - True if the collection is empty

pub async fn repair<C: Connection>( db: &Surreal<C>, id: CollectionId, ) -> StorageResult<bool>

updates the song_count and runtime of the collection

Arguments

• id - The id of the collection to repair

Returns

• bool - True if the collection is empty

pub async fn freeze<C: Connection>( db: &Surreal<C>, id: CollectionId, name: String, ) -> StorageResult<Playlist>

“Freeze” a collection, this will create a playlist with the given name that contains all the songs in the given collection

impl Collection

pub fn generate_id() -> CollectionId

Trait Implementations

impl Clone for Collection

fn clone(&self) -> Collection

Returns a copy of the value.

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

Performs copy-assignment from source.

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 From<&Collection> for CollectionBrief

fn from(collection: &Collection) -> Self

Converts to this type from the input type.

impl From<Collection> for CollectionBrief

fn from(collection: Collection) -> Self

Converts to this type from the input type.

impl PartialEq for Collection

fn eq(&self, other: &Collection) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl Table for Collection

const TABLE_NAME: &'static str = "collection"

fn init_table<C: Connection>( db: &Surreal<C>, ) -> impl Future<Output = Result<()>> + Send

impl Eq for Collection

impl StructuralPartialEq for Collection