jacquard-api 0.12.0-beta.1

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: media.ionosphere.log
//
// This file was automatically generated from Lexicon schemas.
// Any manual changes will be overwritten on the next regeneration.

#[allow(unused_imports)]
use alloc::collections::BTreeMap;

#[allow(unused_imports)]
use core::marker::PhantomData;
use jacquard_common::{CowStr, BosStr, DefaultStr, FromStaticStr};

#[allow(unused_imports)]
use jacquard_common::deps::codegen::unicode_segmentation::UnicodeSegmentation;
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::collection::{Collection, RecordError};
use jacquard_common::types::string::{AtUri, Cid, Datetime};
use jacquard_common::types::uri::{RecordUri, UriError};
use jacquard_common::types::value::Data;
use jacquard_common::xrpc::XrpcResp;
use jacquard_derive::{IntoStatic, lexicon};
use jacquard_lexicon::lexicon::LexiconDoc;
use jacquard_lexicon::schema::LexiconSchema;

#[allow(unused_imports)]
use jacquard_lexicon::validation::{ConstraintError, ValidationPath};
use serde::{Serialize, Deserialize};
use crate::media_ionosphere::Track;
/// Represents information about what was played

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    rename = "media.ionosphere.log",
    tag = "$type",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct Log<S: BosStr = DefaultStr> {
    pub created_at: Datetime,
    ///Version identifier
    pub ionosphere: S,
    pub item: Track<S>,
    ///The programme this log is a part of
    #[serde(skip_serializing_if = "Option::is_none")]
    pub programme: Option<AtUri<S>>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/// Typed wrapper for GetRecord response with this collection's record type.

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct LogGetRecordOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cid: Option<Cid<S>>,
    pub uri: AtUri<S>,
    pub value: Log<S>,
}

impl<S: BosStr> Log<S> {
    pub fn uri(uri: S) -> Result<RecordUri<S, LogRecord>, UriError> {
        RecordUri::try_from_uri(AtUri::new(uri)?)
    }
}

/// Marker type for deserializing records from this collection.

#[derive(Debug, Serialize, Deserialize)]
pub struct LogRecord;
impl XrpcResp for LogRecord {
    const NSID: &'static str = "media.ionosphere.log";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = LogGetRecordOutput<S>;
    type Err = RecordError;
}

impl<S: BosStr> From<LogGetRecordOutput<S>> for Log<S> {
    fn from(output: LogGetRecordOutput<S>) -> Self {
        output.value
    }
}

impl<S: BosStr> Collection for Log<S> {
    const NSID: &'static str = "media.ionosphere.log";
    type Record = LogRecord;
}

impl Collection for LogRecord {
    const NSID: &'static str = "media.ionosphere.log";
    type Record = LogRecord;
}

impl<S: BosStr> LexiconSchema for Log<S> {
    fn nsid() -> &'static str {
        "media.ionosphere.log"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_media_ionosphere_log()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        {
            let value = &self.ionosphere;
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 128usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("ionosphere"),
                    max: 128usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        Ok(())
    }
}

pub mod log_state {

    pub use crate::builder_types::{Set, Unset, IsSet, IsUnset};
    #[allow(unused)]
    use ::core::marker::PhantomData;
    mod sealed {
        pub trait Sealed {}
    }
    /// State trait tracking which required fields have been set
    pub trait State: sealed::Sealed {
        type CreatedAt;
        type Ionosphere;
        type Item;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type CreatedAt = Unset;
        type Ionosphere = Unset;
        type Item = Unset;
    }
    ///State transition - sets the `created_at` field to Set
    pub struct SetCreatedAt<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetCreatedAt<St> {}
    impl<St: State> State for SetCreatedAt<St> {
        type CreatedAt = Set<members::created_at>;
        type Ionosphere = St::Ionosphere;
        type Item = St::Item;
    }
    ///State transition - sets the `ionosphere` field to Set
    pub struct SetIonosphere<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetIonosphere<St> {}
    impl<St: State> State for SetIonosphere<St> {
        type CreatedAt = St::CreatedAt;
        type Ionosphere = Set<members::ionosphere>;
        type Item = St::Item;
    }
    ///State transition - sets the `item` field to Set
    pub struct SetItem<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetItem<St> {}
    impl<St: State> State for SetItem<St> {
        type CreatedAt = St::CreatedAt;
        type Ionosphere = St::Ionosphere;
        type Item = Set<members::item>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `created_at` field
        pub struct created_at(());
        ///Marker type for the `ionosphere` field
        pub struct ionosphere(());
        ///Marker type for the `item` field
        pub struct item(());
    }
}

/// Builder for constructing an instance of this type.
pub struct LogBuilder<S: BosStr, St: log_state::State> {
    _state: PhantomData<fn() -> St>,
    _fields: (Option<Datetime>, Option<S>, Option<Track<S>>, Option<AtUri<S>>),
    _type: PhantomData<fn() -> S>,
}

impl<S: BosStr> Log<S> {
    /// Create a new builder for this type.
    pub fn new() -> LogBuilder<S, log_state::Empty> {
        LogBuilder::new()
    }
}

impl<S: BosStr> LogBuilder<S, log_state::Empty> {
    /// Create a new builder with all fields unset.
    pub fn new() -> Self {
        LogBuilder {
            _state: PhantomData,
            _fields: (None, None, None, None),
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> LogBuilder<S, St>
where
    St: log_state::State,
    St::CreatedAt: log_state::IsUnset,
{
    /// Set the `createdAt` field (required)
    pub fn created_at(
        mut self,
        value: impl Into<Datetime>,
    ) -> LogBuilder<S, log_state::SetCreatedAt<St>> {
        self._fields.0 = Option::Some(value.into());
        LogBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> LogBuilder<S, St>
where
    St: log_state::State,
    St::Ionosphere: log_state::IsUnset,
{
    /// Set the `ionosphere` field (required)
    pub fn ionosphere(
        mut self,
        value: impl Into<S>,
    ) -> LogBuilder<S, log_state::SetIonosphere<St>> {
        self._fields.1 = Option::Some(value.into());
        LogBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> LogBuilder<S, St>
where
    St: log_state::State,
    St::Item: log_state::IsUnset,
{
    /// Set the `item` field (required)
    pub fn item(
        mut self,
        value: impl Into<Track<S>>,
    ) -> LogBuilder<S, log_state::SetItem<St>> {
        self._fields.2 = Option::Some(value.into());
        LogBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St: log_state::State> LogBuilder<S, St> {
    /// Set the `programme` field (optional)
    pub fn programme(mut self, value: impl Into<Option<AtUri<S>>>) -> Self {
        self._fields.3 = value.into();
        self
    }
    /// Set the `programme` field to an Option value (optional)
    pub fn maybe_programme(mut self, value: Option<AtUri<S>>) -> Self {
        self._fields.3 = value;
        self
    }
}

impl<S: BosStr, St> LogBuilder<S, St>
where
    St: log_state::State,
    St::CreatedAt: log_state::IsSet,
    St::Ionosphere: log_state::IsSet,
    St::Item: log_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> Log<S> {
        Log {
            created_at: self._fields.0.unwrap(),
            ionosphere: self._fields.1.unwrap(),
            item: self._fields.2.unwrap(),
            programme: self._fields.3,
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(self, extra_data: BTreeMap<SmolStr, Data<S>>) -> Log<S> {
        Log {
            created_at: self._fields.0.unwrap(),
            ionosphere: self._fields.1.unwrap(),
            item: self._fields.2.unwrap(),
            programme: self._fields.3,
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_media_ionosphere_log() -> LexiconDoc<'static> {
    #[allow(unused_imports)]
    use jacquard_common::{CowStr, deps::smol_str::SmolStr, types::blob::MimeType};
    use jacquard_lexicon::lexicon::*;
    use alloc::collections::BTreeMap;
    LexiconDoc {
        lexicon: Lexicon::Lexicon1,
        id: CowStr::new_static("media.ionosphere.log"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    description: Some(
                        CowStr::new_static(
                            "Represents information about what was played",
                        ),
                    ),
                    key: Some(CowStr::new_static("tid")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(
                            vec![
                                SmolStr::new_static("ionosphere"),
                                SmolStr::new_static("createdAt"),
                                SmolStr::new_static("item")
                            ],
                        ),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("createdAt"),
                                LexObjectProperty::String(LexString {
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("ionosphere"),
                                LexObjectProperty::String(LexString {
                                    description: Some(CowStr::new_static("Version identifier")),
                                    max_length: Some(128usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("item"),
                                LexObjectProperty::Union(LexRefUnion {
                                    refs: vec![
                                        CowStr::new_static("media.ionosphere.defs#track")
                                    ],
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("programme"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static("The programme this log is a part of"),
                                    ),
                                    format: Some(LexStringFormat::AtUri),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}