jacquard-api 0.10.2

Generated AT Protocol API bindings for Jacquard
Documentation
// @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.

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

#[derive(
    serde::Serialize,
    serde::Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    jacquard_derive::IntoStatic
)]
#[serde(rename_all = "camelCase")]
pub struct GetChapter<'a> {
    #[serde(borrow)]
    pub chapter: jacquard_common::types::string::AtUri<'a>,
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub entry_cursor: std::option::Option<jacquard_common::CowStr<'a>>,
    ///Defaults to `50`. Min: 1. Max: 100.
    #[serde(default = "_default_entry_limit")]
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    pub entry_limit: std::option::Option<i64>,
}

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<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetChapter<S> {}
    impl<S: State> State for SetChapter<S> {
        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<'a, S: get_chapter_state::State> {
    _phantom_state: ::core::marker::PhantomData<fn() -> S>,
    __unsafe_private_named: (
        ::core::option::Option<jacquard_common::types::string::AtUri<'a>>,
        ::core::option::Option<jacquard_common::CowStr<'a>>,
        ::core::option::Option<i64>,
    ),
    _phantom: ::core::marker::PhantomData<&'a ()>,
}

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

impl<'a> GetChapterBuilder<'a, get_chapter_state::Empty> {
    /// Create a new builder with all fields unset
    pub fn new() -> Self {
        GetChapterBuilder {
            _phantom_state: ::core::marker::PhantomData,
            __unsafe_private_named: (None, None, None),
            _phantom: ::core::marker::PhantomData,
        }
    }
}

impl<'a, S> GetChapterBuilder<'a, S>
where
    S: get_chapter_state::State,
    S::Chapter: get_chapter_state::IsUnset,
{
    /// Set the `chapter` field (required)
    pub fn chapter(
        mut self,
        value: impl Into<jacquard_common::types::string::AtUri<'a>>,
    ) -> GetChapterBuilder<'a, get_chapter_state::SetChapter<S>> {
        self.__unsafe_private_named.0 = ::core::option::Option::Some(value.into());
        GetChapterBuilder {
            _phantom_state: ::core::marker::PhantomData,
            __unsafe_private_named: self.__unsafe_private_named,
            _phantom: ::core::marker::PhantomData,
        }
    }
}

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

impl<'a, S: get_chapter_state::State> GetChapterBuilder<'a, S> {
    /// Set the `entryLimit` field (optional)
    pub fn entry_limit(mut self, value: impl Into<Option<i64>>) -> Self {
        self.__unsafe_private_named.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.__unsafe_private_named.2 = value;
        self
    }
}

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

#[jacquard_derive::lexicon]
#[derive(
    serde::Serialize,
    serde::Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    jacquard_derive::IntoStatic
)]
#[serde(rename_all = "camelCase")]
pub struct GetChapterOutput<'a> {
    #[serde(borrow)]
    pub chapter: crate::sh_weaver::notebook::ChapterView<'a>,
    #[serde(borrow)]
    pub entries: Vec<crate::sh_weaver::notebook::ChapterEntryView<'a>>,
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub entry_cursor: std::option::Option<jacquard_common::CowStr<'a>>,
}

#[jacquard_derive::open_union]
#[derive(
    serde::Serialize,
    serde::Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    thiserror::Error,
    miette::Diagnostic,
    jacquard_derive::IntoStatic
)]
#[serde(tag = "error", content = "message")]
#[serde(bound(deserialize = "'de: 'a"))]
pub enum GetChapterError<'a> {
    #[serde(rename = "ChapterNotFound")]
    ChapterNotFound(std::option::Option<jacquard_common::CowStr<'a>>),
}

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::Unknown(err) => write!(f, "Unknown error: {:?}", err),
        }
    }
}

/// 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<'de> = GetChapterOutput<'de>;
    type Err<'de> = GetChapterError<'de>;
}

impl<'a> jacquard_common::xrpc::XrpcRequest for GetChapter<'a> {
    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<'de> = GetChapter<'de>;
    type Response = GetChapterResponse;
}