libveezi 0.4.1

A Rust client for the Veezi API
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

//! [`Attribute`]s that can be associated with [`crate::session::Session`]s and
//! [`crate::film::Film`]s

use std::fmt::{self, Debug, Display, Formatter};

use serde::Deserialize;

use crate::{client::Client, error::ApiResult, session::SessionList};

/// The unique ID of an [`Attribute`]
#[derive(Deserialize, Debug, PartialEq, Eq, Clone, Hash)]
#[serde(transparent)]
pub struct AttributeId(String);
impl AttributeId {
    /// Get the string representation of this [`AttributeId`]
    #[must_use]
    pub fn as_str(&self) -> &str {
        &self.0
    }

    /// Fetch the full [`Attribute`] associated with this [`AttributeId`]
    ///
    /// # Errors
    ///
    /// This function will return an error if the API request fails.
    pub async fn fetch(&self, client: &Client) -> ApiResult<Attribute> {
        client.get_attribute(self).await
    }
}
impl Display for AttributeId {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

/// An attribute that can be associated with [`crate::session::Session`]s
#[derive(Deserialize, Debug, PartialEq, Eq, Clone)]
#[serde(rename_all = "PascalCase")]
pub struct Attribute {
    /// The unique ID of the attribute
    pub id: AttributeId,
    /// The name of the attribute
    pub description: String,
    /// The short name of the attribute
    pub short_name: String,
    /// The font color associated with the attribute (hex code)
    pub font_color: String,
    /// The background color associated with the attribute (hex code)
    pub background_color: String,
    /// Whether to show this attribute on sessions that have no complimentary
    /// tickets
    pub show_on_sessions_with_no_comps: bool,
}
impl Attribute {
    /// Get a list of all future [`crate::session::Session`]s containing this
    /// [`Attribute`]
    ///
    /// # Errors
    ///
    /// This function will return an error if the API request fails.
    pub async fn sessions(&self, client: &Client) -> ApiResult<SessionList> {
        Ok(client
            .list_sessions()
            .await?
            .filter_containing_attribute(&self.id))
    }
}