Struct database::mediafile::MediaFile

source · [−]

pub struct MediaFile {Show 18 fields
    pub id: i64,
    pub media_id: Option<i64>,
    pub library_id: i64,
    pub target_file: String,
    pub raw_name: String,
    pub raw_year: Option<i64>,
    pub quality: Option<String>,
    pub codec: Option<String>,
    pub container: Option<String>,
    pub audio: Option<String>,
    pub original_resolution: Option<String>,
    pub duration: Option<i64>,
    pub episode: Option<i64>,
    pub season: Option<i64>,
    pub corrupt: Option<bool>,
    pub channels: Option<i64>,
    pub profile: Option<String>,
    pub audio_language: Option<String>,
}

Expand description

MediaFile struct which represents a media file on the filesystem. This struct holds some basic information which the video player on the front end might require.

Fields

id: i64

Unique identifier of a mediafile.

media_id: Option<i64>

Foreign key linking this entry to the media table or Media struct

library_id: i64

Library foreign key linking this entry to the library table or Library struct

target_file: String

String representing the file path of the file we target. This should be a real path on the filesystem.

raw_name: String

Raw name that we extract from the filename using regex and the parse-torrent-name library

raw_year: Option<i64>

Raw year we might be able to extract from the filename using regex and the parse-torrent-name library

quality: Option<String>

Quality string that we might get from ffprobe when running it against our file

codec: Option<String>

Codec that we might get from ffprobe when running it against our file

container: Option<String>

Container descriptor that we might get from ffprobe

audio: Option<String>

Audio codec specifier that we might get from ffprobe

original_resolution: Option<String>

Video resolution that we can obtain from ffprobe

duration: Option<i64>

Duration of the video file that we obtain from ffprobe

episode: Option<i64>

Episode number that we might get from using regex and the parse-torrent-name crate. This is specific to tv shows only.

season: Option<i64>

Season number that we might get from using regexa and the parse-torrent-name crate. This is specific to tv shows only.

corrupt: Option<bool>

Flag which tells us if the file is corrupted or not. ie if ffprobe cant open the file and reports no metadata this flag will be set.

channels: Option<i64>

Audio channels count

profile: Option<String>

avc_profile

audio_language: Option<String>

Primary audio language

Implementations

source

impl MediaFile

source

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

Method returns all mediafiles associated with a library.

Arguments

conn - mutable reference to a sqlx transaction.
lib - reference to a Library object that we will match against

source

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

Method returns all mediafiles associated with a library and filters for those not associated with a media

Arguments

conn - mutable reference to a sqlx transaction.
lib - reference to a Library object that we will match against

source

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

Method returns all mediafiles associated with a Media object.

Arguments

conn - mutable reference to a sqlx transaction.
lib - reference to a Library object that we will match against

source

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

source

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

Method returns all metadata of a mediafile based on the id supplied.

Arguments

conn - mutable reference to a sqlx transaction.
_id - id of the mediafile object we are targetting

source

pub async fn get_many(
conn: &mut Transaction<'_>,
ids: &[i64 ]
) -> Result<Vec<Self>, DatabaseError>

Method returns all metadata for a set of mediafile ids.

Arguments

conn - mutable reference to a sqlx transaction.
ids - list of mediafile ids

source

pub async fn exists_by_file(conn: &mut Transaction<'_>, file: &str) -> bool

Method checks whether a mediafile entry with the filepath supplied exists or not, returning a bool.

Arguments

conn - mutable reference to a sqlx transaction.
file - string slice containing our filepath

source

pub async fn get_by_file(
conn: &mut Transaction<'_>,
file: &str
) -> Result<Self, DatabaseError>

source

pub async fn get_largest_duration(
conn: &mut Transaction<'_>,
media_id: i64
) -> Result<i64, DatabaseError>

Function will return the largest duration for a media.

source

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

Method deletes mediafile matching the id supplied

Arguments

conn - mutable reference to a sqlx transaction.
_id - id of the mediafile entry we want to delete

source

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

Function deletes all mediafiles with library_id of lib_id. This function is used when deleting a library with a sqlite backend.

Trait Implementations

source

impl Clone for MediaFile

source

fn clone(&self) -> MediaFile

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for MediaFile

source

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

Formats the value using the given formatter. Read more

source

impl<'a, R: Row> FromRow<'a, R> for MediaFile where
 &'a str: ColumnIndex<R>,
 i64: Decode<'a, R::Database>,
 i64: Type<R::Database>,
 Option<i64>: Decode<'a, R::Database>,
 Option<i64>: Type<R::Database>,
 i64: Decode<'a, R::Database>,
 i64: Type<R::Database>,
 String: Decode<'a, R::Database>,
 String: Type<R::Database>,
 String: Decode<'a, R::Database>,
 String: Type<R::Database>,
 Option<i64>: Decode<'a, R::Database>,
 Option<i64>: Type<R::Database>,
 Option<String>: Decode<'a, R::Database>,
 Option<String>: Type<R::Database>,
 Option<String>: Decode<'a, R::Database>,
 Option<String>: Type<R::Database>,
 Option<String>: Decode<'a, R::Database>,
 Option<String>: Type<R::Database>,
 Option<String>: Decode<'a, R::Database>,
 Option<String>: Type<R::Database>,
 Option<String>: Decode<'a, R::Database>,
 Option<String>: Type<R::Database>,
 Option<i64>: Decode<'a, R::Database>,
 Option<i64>: Type<R::Database>,
 Option<i64>: Decode<'a, R::Database>,
 Option<i64>: Type<R::Database>,
 Option<i64>: Decode<'a, R::Database>,
 Option<i64>: Type<R::Database>,
 Option<bool>: Decode<'a, R::Database>,
 Option<bool>: Type<R::Database>,
 Option<i64>: Decode<'a, R::Database>,
 Option<i64>: Type<R::Database>,
 Option<String>: Decode<'a, R::Database>,
 Option<String>: Type<R::Database>,
 Option<String>: Decode<'a, R::Database>,
 Option<String>: Type<R::Database>,

source

fn from_row(row: &'a R) -> Result<Self>

source

impl Into<Media> for MediaFile

source

fn into(self) -> Media

Converts this type into the (usually inferred) input type.

source

impl PartialEq<MediaFile> for MediaFile

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

source

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

This method tests for !=.

source

impl Serialize for MediaFile

source

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

Serialize this value into the given Serde serializer. Read more

source

impl StructuralPartialEq for MediaFile

Auto Trait Implementations

impl RefUnwindSafe for MediaFile

impl Send for MediaFile

impl Sync for MediaFile

impl Unpin for MediaFile

impl UnwindSafe for MediaFile

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct database::mediafile::MediaFile

Fields

Implementations

impl MediaFile

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

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

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

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

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

pub async fn get_many( conn: &mut Transaction<'_>, ids: &[i64]) -> Result<Vec<Self>, DatabaseError>

pub async fn exists_by_file(conn: &mut Transaction<'_>, file: &str) -> bool

pub async fn get_by_file( conn: &mut Transaction<'_>, file: &str) -> Result<Self, DatabaseError>

pub async fn get_largest_duration( conn: &mut Transaction<'_>, media_id: i64) -> Result<i64, DatabaseError>

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

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

Trait Implementations

impl Clone for MediaFile

fn clone(&self) -> MediaFile

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

impl Debug for MediaFile

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

fn from_row(row: &'a R) -> Result<Self>

impl Into<Media> for MediaFile

fn into(self) -> Media

impl PartialEq<MediaFile> for MediaFile

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

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

impl Serialize for MediaFile

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

impl StructuralPartialEq for MediaFile

Auto Trait Implementations

impl RefUnwindSafe for MediaFile

impl Send for MediaFile

impl Sync for MediaFile

impl Unpin for MediaFile

impl UnwindSafe for MediaFile

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

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

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

pub async fn get_many(
conn: &mut Transaction<'_>,
ids: &[i64 ]
) -> Result<Vec<Self>, DatabaseError>

pub async fn get_by_file(
conn: &mut Transaction<'_>,
file: &str
) -> Result<Self, DatabaseError>

pub async fn get_largest_duration(
conn: &mut Transaction<'_>,
media_id: i64
) -> Result<i64, DatabaseError>

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,