ferrex-model 0.1.2-alpha

Shared data models for the Ferrex media platform
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

use uuid::Uuid;

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

/// Episode identity independent of files
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct EpisodeKey {
    pub tmdb_series_id: u64,
    pub season_number: u16,
    pub episode_number: u16,
}

/// Season identity independent of files
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct SeasonKey {
    pub tmdb_series_id: u64,
    pub season_number: u16,
}

/// Reason chosen for the next episode pick
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))]
pub enum NextReason {
    ResumeInProgress,
    FirstUnwatched,
}

/// Description of the next episode to play
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct NextEpisode {
    pub key: EpisodeKey,
    /// If available, a specific playable episode reference (media UUID)
    pub playable_media_id: Option<Uuid>,
    pub reason: NextReason,
}

/// Per-episode watch status
#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(tag = "state", rename_all = "snake_case"))]
pub enum EpisodeStatus {
    Unwatched,
    InProgress { progress: f32 },
    Completed,
}

impl EpisodeStatus {
    pub fn is_completed(&self) -> bool {
        matches!(self, EpisodeStatus::Completed)
    }
}

/// Aggregated season watch status
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct SeasonWatchStatus {
    pub key: SeasonKey,
    pub total: u32,
    pub watched: u32,
    pub in_progress: u32,
    pub is_completed: bool,
    /// Map of episode number -> status
    pub episodes: std::collections::HashMap<u16, EpisodeStatus>,
}

/// Aggregated series watch status with next-episode hint
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct SeriesWatchStatus {
    pub tmdb_series_id: u64,
    pub total_episodes: u32,
    pub watched: u32,
    pub in_progress: u32,
    pub seasons: std::collections::HashMap<u16, SeasonWatchStatus>,
    pub next_episode: Option<NextEpisode>,
}