Struct database::library::Library

pub struct Library {
    pub id: i64,
    pub name: String,
    pub locations: Vec<String>,
    pub media_type: MediaType,
    pub hidden: bool,
}

Library struct which we can use to deserialize database queries into.

Fields

id: i64

name: String

unique name of the library

locations: Vec<String>

a path on the filesystem that holds media. ie /home/user/media/movies

media_type: MediaType

Enum used to identify the media type that this library contains. At the moment only movie and tv are supported

hidden: bool

Is library hidden?

Implementations

impl Library

pub async fn get_all(conn: &mut Transaction<'_>) -> Vec<Self>

Method returns all libraries that exist in the database in the form of a Vec. If no libraries are found the the Vec will just be empty.

This method will not return the locations indexed for this library, if you need those you must query for them separately.

pub async fn get_locations(
    conn: &mut Transaction<'_>,
    id: i64
) -> Result<Vec<String>, DatabaseError>

pub async fn get_one(
    conn: &mut Transaction<'_>,
    lib_id: i64
) -> Result<Self, DatabaseError>

Method filters the database for a library with the id supplied and returns it. This method will also fetch the indexed locations for this library.

Arguments

• conn - mutable reference to a sqlx transaction.
• lib_id - a integer that is the id of the library we are trying to query

pub async fn delete(
    conn: &mut Transaction<'_>,
    id_to_del: i64
) -> Result<usize, DatabaseError>

Method filters the database for a library with the id supplied and deletes it.

Arguments

• conn - mutable reference to a sqlx transaction.
• lib_id - a integer that is the id of the library we are trying to query

pub async fn mark_hidden(
    conn: &mut Transaction<'_>,
    id: i64
) -> Result<usize, DatabaseError>

pub async fn get_size(
    tx: &mut Transaction<'_>,
    id: i64
) -> Result<usize, DatabaseError>

Trait Implementations

impl Clone for Library

fn clone(&self) -> Library

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for Library

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Library

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

Serialize this value into the given Serde serializer.