selene-core 0.9.0-alpha.2

selene-core is the backend for Selene, a local-first music player
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
90
91
92
93
94
95
96

use std::convert::Infallible;

use chrono::{DateTime, Utc};
use lunar_lib::{
    formatter::{FormatTable, Taggable},
    id::Id,
    paths::sys::sanitize_str,
};
use serde::{Deserialize, Serialize};

use crate::library::{
    album::Album,
    artist::Artist,
    image_art::ImageArt,
    track::{Track, lyric_data::LyricData},
};

/// Track metadata. Defines metadata to be read from and stored on files
#[derive(Debug, Deserialize, Serialize, Clone, Default)]
pub struct TrackMeta {
    /// The album this track belongs to
    ///
    /// # Database Safety
    ///
    /// When changing this value:
    /// - The old album should have its reference to this track removed
    /// - The new album needs to have a pointer to this track added
    pub album: Option<Id<Album>>,

    /// The artists this track belong to
    ///
    /// # Database Safety
    ///
    /// When changing this value:
    /// - The remove artists should have its reference to this track removed
    /// - The added artists need to have a pointer to this track added
    pub artists: Vec<Id<Artist>>,
    pub date: Option<DateTime<Utc>>,
    pub genre: Vec<String>,
    pub lyric_data: Option<LyricData>,
    pub art: Option<Id<ImageArt>>,
    pub other: Vec<(String, String)>,
    pub title: Option<String>,
}

impl TrackMeta {
    #[must_use]
    pub fn new() -> Self {
        Self {
            title: None,
            artists: Vec::new(),
            album: None,

            date: None,
            genre: Vec::new(),
            art: None,

            lyric_data: None,

            other: Vec::new(),
        }
    }

    #[must_use]
    pub fn artists(&self) -> &[Id<Artist>] {
        &self.artists
    }

    #[must_use]
    pub fn album(&self) -> Option<Id<Album>> {
        self.album
    }

    #[must_use]
    pub fn safe_title(&self) -> &str {
        self.title.as_deref().unwrap_or(Track::UNKNOWN)
    }
}

impl Taggable for TrackMeta {
    type Err = Infallible;

    fn fill_table(&self, table: &mut FormatTable) -> Result<(), Self::Err> {
        if let Some(value) = self.date {
            table.add_entry("date", value.to_string());
        }
        if let Some(value) = &self.title {
            table.add_entry("title", sanitize_str(value));
        }
        if !self.genre.is_empty() {
            table.add_entry("genre", sanitize_str(self.genre.join(";")));
        }

        Ok(())
    }
}