jacquard-api 0.12.0-beta.2

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: pub.quizzy.quizBegin
//
// 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::{BosStr, CowStr, 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;

use crate::com_atproto::repo::strong_ref::StrongRef;
#[allow(unused_imports)]
use jacquard_lexicon::validation::{ConstraintError, ValidationPath};
use serde::{Deserialize, Serialize};
/// Marks the start of a quiz session

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    rename = "pub.quizzy.quizBegin",
    tag = "$type",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct QuizBegin<S: BosStr = DefaultStr> {
    ///When the quiz ends
    pub ends_at: Datetime,
    ///Reference to the league running this quiz
    pub league: StrongRef<S>,
    ///Reference to the quiz being played
    pub quiz: StrongRef<S>,
    ///When the quiz starts
    pub started_at: Datetime,
    #[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 QuizBeginGetRecordOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cid: Option<Cid<S>>,
    pub uri: AtUri<S>,
    pub value: QuizBegin<S>,
}

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

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

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

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

impl<S: BosStr> Collection for QuizBegin<S> {
    const NSID: &'static str = "pub.quizzy.quizBegin";
    type Record = QuizBeginRecord;
}

impl Collection for QuizBeginRecord {
    const NSID: &'static str = "pub.quizzy.quizBegin";
    type Record = QuizBeginRecord;
}

impl<S: BosStr> LexiconSchema for QuizBegin<S> {
    fn nsid() -> &'static str {
        "pub.quizzy.quizBegin"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_pub_quizzy_quizBegin()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

pub mod quiz_begin_state {

    pub use crate::builder_types::{IsSet, IsUnset, Set, Unset};
    #[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 EndsAt;
        type League;
        type StartedAt;
        type Quiz;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type EndsAt = Unset;
        type League = Unset;
        type StartedAt = Unset;
        type Quiz = Unset;
    }
    ///State transition - sets the `ends_at` field to Set
    pub struct SetEndsAt<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetEndsAt<St> {}
    impl<St: State> State for SetEndsAt<St> {
        type EndsAt = Set<members::ends_at>;
        type League = St::League;
        type StartedAt = St::StartedAt;
        type Quiz = St::Quiz;
    }
    ///State transition - sets the `league` field to Set
    pub struct SetLeague<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetLeague<St> {}
    impl<St: State> State for SetLeague<St> {
        type EndsAt = St::EndsAt;
        type League = Set<members::league>;
        type StartedAt = St::StartedAt;
        type Quiz = St::Quiz;
    }
    ///State transition - sets the `started_at` field to Set
    pub struct SetStartedAt<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetStartedAt<St> {}
    impl<St: State> State for SetStartedAt<St> {
        type EndsAt = St::EndsAt;
        type League = St::League;
        type StartedAt = Set<members::started_at>;
        type Quiz = St::Quiz;
    }
    ///State transition - sets the `quiz` field to Set
    pub struct SetQuiz<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetQuiz<St> {}
    impl<St: State> State for SetQuiz<St> {
        type EndsAt = St::EndsAt;
        type League = St::League;
        type StartedAt = St::StartedAt;
        type Quiz = Set<members::quiz>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `ends_at` field
        pub struct ends_at(());
        ///Marker type for the `league` field
        pub struct league(());
        ///Marker type for the `started_at` field
        pub struct started_at(());
        ///Marker type for the `quiz` field
        pub struct quiz(());
    }
}

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

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

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

impl<S: BosStr, St> QuizBeginBuilder<S, St>
where
    St: quiz_begin_state::State,
    St::EndsAt: quiz_begin_state::IsUnset,
{
    /// Set the `endsAt` field (required)
    pub fn ends_at(
        mut self,
        value: impl Into<Datetime>,
    ) -> QuizBeginBuilder<S, quiz_begin_state::SetEndsAt<St>> {
        self._fields.0 = Option::Some(value.into());
        QuizBeginBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> QuizBeginBuilder<S, St>
where
    St: quiz_begin_state::State,
    St::League: quiz_begin_state::IsUnset,
{
    /// Set the `league` field (required)
    pub fn league(
        mut self,
        value: impl Into<StrongRef<S>>,
    ) -> QuizBeginBuilder<S, quiz_begin_state::SetLeague<St>> {
        self._fields.1 = Option::Some(value.into());
        QuizBeginBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> QuizBeginBuilder<S, St>
where
    St: quiz_begin_state::State,
    St::Quiz: quiz_begin_state::IsUnset,
{
    /// Set the `quiz` field (required)
    pub fn quiz(
        mut self,
        value: impl Into<StrongRef<S>>,
    ) -> QuizBeginBuilder<S, quiz_begin_state::SetQuiz<St>> {
        self._fields.2 = Option::Some(value.into());
        QuizBeginBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> QuizBeginBuilder<S, St>
where
    St: quiz_begin_state::State,
    St::StartedAt: quiz_begin_state::IsUnset,
{
    /// Set the `startedAt` field (required)
    pub fn started_at(
        mut self,
        value: impl Into<Datetime>,
    ) -> QuizBeginBuilder<S, quiz_begin_state::SetStartedAt<St>> {
        self._fields.3 = Option::Some(value.into());
        QuizBeginBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> QuizBeginBuilder<S, St>
where
    St: quiz_begin_state::State,
    St::EndsAt: quiz_begin_state::IsSet,
    St::League: quiz_begin_state::IsSet,
    St::StartedAt: quiz_begin_state::IsSet,
    St::Quiz: quiz_begin_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> QuizBegin<S> {
        QuizBegin {
            ends_at: self._fields.0.unwrap(),
            league: self._fields.1.unwrap(),
            quiz: self._fields.2.unwrap(),
            started_at: self._fields.3.unwrap(),
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(self, extra_data: BTreeMap<SmolStr, Data<S>>) -> QuizBegin<S> {
        QuizBegin {
            ends_at: self._fields.0.unwrap(),
            league: self._fields.1.unwrap(),
            quiz: self._fields.2.unwrap(),
            started_at: self._fields.3.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_pub_quizzy_quizBegin() -> LexiconDoc<'static> {
    use alloc::collections::BTreeMap;
    #[allow(unused_imports)]
    use jacquard_common::{CowStr, deps::smol_str::SmolStr, types::blob::MimeType};
    use jacquard_lexicon::lexicon::*;
    LexiconDoc {
        lexicon: Lexicon::Lexicon1,
        id: CowStr::new_static("pub.quizzy.quizBegin"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    description: Some(CowStr::new_static("Marks the start of a quiz session")),
                    key: Some(CowStr::new_static("tid")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(vec![
                            SmolStr::new_static("league"),
                            SmolStr::new_static("quiz"),
                            SmolStr::new_static("startedAt"),
                            SmolStr::new_static("endsAt"),
                        ]),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("endsAt"),
                                LexObjectProperty::String(LexString {
                                    description: Some(CowStr::new_static("When the quiz ends")),
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("league"),
                                LexObjectProperty::Ref(LexRef {
                                    r#ref: CowStr::new_static("com.atproto.repo.strongRef"),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("quiz"),
                                LexObjectProperty::Ref(LexRef {
                                    r#ref: CowStr::new_static("com.atproto.repo.strongRef"),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("startedAt"),
                                LexObjectProperty::String(LexString {
                                    description: Some(CowStr::new_static("When the quiz starts")),
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}