flix-fs 0.0.18

Filesystem scanner for flix media
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! This module contains all of the filesystem scanner modules
//!
//! The most common scanner to use is [generic::Scanner] which will
//! automatically detect and use the appropriate scanner.

use flix_model::id::{CollectionId, MovieId, ShowId};
use flix_model::numbers::{EpisodeNumbers, SeasonNumber};

pub mod library;

pub mod generic;

pub mod collection;

pub mod movie;

pub mod episode;
pub mod season;
pub mod show;

/// A reference to a piece of media
#[derive(Debug, Clone)]
pub enum MediaRef<ID> {
	/// An explicit ID
	Id(ID),
	/// A filesystem slug
	Slug(String),
}

/// A scanned collection
#[derive(Debug)]
pub struct CollectionScan {
	/// The ID of the parent collection (if any)
	pub parent_ref: Option<MediaRef<CollectionId>>,
	/// The ID of the collection
	pub id_ref: MediaRef<CollectionId>,
	/// The file name of the poster file
	pub poster_file_name: Option<String>,
}

/// A scanned movie
#[derive(Debug)]
pub struct MovieScan {
	/// The ID of the parent collection (if any)
	pub parent_ref: Option<MediaRef<CollectionId>>,
	/// The ID of the movie
	pub id_ref: MediaRef<MovieId>,
	/// The file name of the media file
	pub media_file_name: String,
	/// The file name of the poster file
	pub poster_file_name: Option<String>,
}

/// A scanned show
#[derive(Debug)]
pub struct ShowScan {
	/// The ID of the parent collection (if any)
	pub parent_ref: Option<MediaRef<CollectionId>>,
	/// The ID of the show
	pub id_ref: MediaRef<ShowId>,
	/// The file name of the poster file
	pub poster_file_name: Option<String>,
}

/// A scanned season
#[derive(Debug)]
pub struct SeasonScan {
	/// The ID of the show this season belongs to
	pub show_ref: MediaRef<ShowId>,
	/// The season this episode belongs to
	pub season: SeasonNumber,
	/// The file name of the poster file
	pub poster_file_name: Option<String>,
}

/// A scanned episode
#[derive(Debug)]
pub struct EpisodeScan {
	/// The ID of the show this episode belongs to
	pub show_ref: MediaRef<ShowId>,
	/// The season this episode belongs to
	pub season: SeasonNumber,
	/// The number(s) of this episode
	pub episode: EpisodeNumbers,
	/// The file name of the media file
	pub media_file_name: String,
	/// The file name of the poster file
	pub poster_file_name: Option<String>,
}