Scanner

flix_fs::scanner::generic

Enum Scanner 

Source 
pub enum Scanner {
    Collection {
        parent: Option<CollectionId>,
        id: CollectionId,
        poster_file_name: Option<String>,
    },
    Movie {
        parent: Option<CollectionId>,
        id: MovieId,
        media_file_name: String,
        poster_file_name: Option<String>,
    },
    Show {
        parent: Option<CollectionId>,
        id: ShowId,
        poster_file_name: Option<String>,
    },
    Season {
        show: ShowId,
        season: SeasonNumber,
        poster_file_name: Option<String>,
    },
    Episode {
        show: ShowId,
        season: SeasonNumber,
        episode: EpisodeNumbers,
        media_file_name: String,
        poster_file_name: Option<String>,
    },
}
Expand description

The scanner for collections

Variants§

§

Collection

A scanned collection

Fields

§parent: Option<CollectionId>

The ID of the parent collection (if any)

§id: CollectionId

The ID of the collection

§poster_file_name: Option<String>

The file name of the poster file

§

Movie

A scanned movie

Fields

§parent: Option<CollectionId>

The ID of the parent collection (if any)

§id: MovieId

The ID of the movie

§media_file_name: String

The file name of the media file

§poster_file_name: Option<String>

The file name of the poster file

§

Show

A scanned show

Fields

§parent: Option<CollectionId>

The ID of the parent collection (if any)

§id: ShowId

The ID of the show

§poster_file_name: Option<String>

The file name of the poster file

§

Season

A scanned episode

Fields

§show: ShowId

The ID of the show this season belongs to

§season: SeasonNumber

The season this episode belongs to

§poster_file_name: Option<String>

The file name of the poster file

§

Episode

A scanned episode

Fields

§show: ShowId

The ID of the show this episode belongs to

§season: SeasonNumber

The season this episode belongs to

§episode: EpisodeNumbers

The number(s) of this episode

§media_file_name: String

The file name of the media file

§poster_file_name: Option<String>

The file name of the poster file

Implementations§

Source§

impl Scanner

Source

pub fn scan_detect_folder( path: &Path, parent: Option<CollectionId>, ) -> impl Stream<Item = Item>

Detect the type of a folder and call the correct scanner. Use this only for detecting possibly ambiguous media:

  • Collections
  • Movies
  • Shows

Trait Implementations§

Source§

impl From<Scanner> for Scanner

Source§

fn from(value: Scanner) -> Self

Converts to this type from the input type.
Source§

impl From<Scanner> for Scanner

Source§

fn from(value: Scanner) -> Self

Converts to this type from the input type.
Source§

impl From<Scanner> for Scanner

Source§

fn from(value: Scanner) -> Self

Converts to this type from the input type.
Source§

impl From<Scanner> for Scanner

Source§

fn from(value: Scanner) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

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<U> for T
where U: From<T>,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
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