jacquard-api 0.12.0-beta.1

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: sh.weaver.notebook.getChapter
//
// 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};
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::string::AtUri;
use jacquard_common::types::value::Data;
use jacquard_derive::{IntoStatic, open_union};
use serde::{Serialize, Deserialize};
use crate::sh_weaver::notebook::ChapterEntryView;
use crate::sh_weaver::notebook::ChapterView;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetChapter<S: BosStr = DefaultStr> {
    pub chapter: AtUri<S>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub entry_cursor: Option<S>,
    ///Defaults to `50`. Min: 1. Max: 100.
    #[serde(default = "_default_entry_limit")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub entry_limit: Option<i64>,
}


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetChapterOutput<S: BosStr = DefaultStr> {
    pub chapter: ChapterView<S>,
    pub entries: Vec<ChapterEntryView<S>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub entry_cursor: Option<S>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}


#[derive(
    Serialize,
    Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    thiserror::Error,
    miette::Diagnostic
)]

#[serde(tag = "error", content = "message")]
pub enum GetChapterError {
    #[serde(rename = "ChapterNotFound")]
    ChapterNotFound(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other { error: SmolStr, message: Option<SmolStr> },
}

impl core::fmt::Display for GetChapterError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::ChapterNotFound(msg) => {
                write!(f, "ChapterNotFound")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::Other { error, message } => {
                write!(f, "{}", error)?;
                if let Some(msg) = message {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
        }
    }
}

/// Response type for sh.weaver.notebook.getChapter
pub struct GetChapterResponse;
impl jacquard_common::xrpc::XrpcResp for GetChapterResponse {
    const NSID: &'static str = "sh.weaver.notebook.getChapter";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = GetChapterOutput<S>;
    type Err = GetChapterError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for GetChapter<S> {
    const NSID: &'static str = "sh.weaver.notebook.getChapter";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetChapterResponse;
}

/// Endpoint type for sh.weaver.notebook.getChapter
pub struct GetChapterRequest;
impl jacquard_common::xrpc::XrpcEndpoint for GetChapterRequest {
    const PATH: &'static str = "/xrpc/sh.weaver.notebook.getChapter";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<S: BosStr> = GetChapter<S>;
    type Response = GetChapterResponse;
}

fn _default_entry_limit() -> Option<i64> {
    Some(50i64)
}

pub mod get_chapter_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 Chapter;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Chapter = Unset;
    }
    ///State transition - sets the `chapter` field to Set
    pub struct SetChapter<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetChapter<St> {}
    impl<St: State> State for SetChapter<St> {
        type Chapter = Set<members::chapter>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `chapter` field
        pub struct chapter(());
    }
}

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

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

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

impl<S: BosStr, St> GetChapterBuilder<S, St>
where
    St: get_chapter_state::State,
    St::Chapter: get_chapter_state::IsUnset,
{
    /// Set the `chapter` field (required)
    pub fn chapter(
        mut self,
        value: impl Into<AtUri<S>>,
    ) -> GetChapterBuilder<S, get_chapter_state::SetChapter<St>> {
        self._fields.0 = Option::Some(value.into());
        GetChapterBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St: get_chapter_state::State> GetChapterBuilder<S, St> {
    /// Set the `entryCursor` field (optional)
    pub fn entry_cursor(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.1 = value.into();
        self
    }
    /// Set the `entryCursor` field to an Option value (optional)
    pub fn maybe_entry_cursor(mut self, value: Option<S>) -> Self {
        self._fields.1 = value;
        self
    }
}

impl<S: BosStr, St: get_chapter_state::State> GetChapterBuilder<S, St> {
    /// Set the `entryLimit` field (optional)
    pub fn entry_limit(mut self, value: impl Into<Option<i64>>) -> Self {
        self._fields.2 = value.into();
        self
    }
    /// Set the `entryLimit` field to an Option value (optional)
    pub fn maybe_entry_limit(mut self, value: Option<i64>) -> Self {
        self._fields.2 = value;
        self
    }
}

impl<S: BosStr, St> GetChapterBuilder<S, St>
where
    St: get_chapter_state::State,
    St::Chapter: get_chapter_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> GetChapter<S> {
        GetChapter {
            chapter: self._fields.0.unwrap(),
            entry_cursor: self._fields.1,
            entry_limit: self._fields.2,
        }
    }
}