jacquard-api 0.12.0-beta.2

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: sh.weaver.notebook.getPage
//
// 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;

use crate::sh_weaver::notebook::EntryView;
use crate::sh_weaver::notebook::PageView;
#[allow(unused_imports)]
use core::marker::PhantomData;
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::string::AtUri;
use jacquard_common::types::value::Data;
use jacquard_common::{BosStr, CowStr, DefaultStr, FromStaticStr};
use jacquard_derive::{IntoStatic, open_union};
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct GetPage<S: BosStr = DefaultStr> {
    pub page: AtUri<S>,
}

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct GetPageOutput<S: BosStr = DefaultStr> {
    pub entries: Vec<EntryView<S>>,
    pub page: PageView<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 GetPageError {
    #[serde(rename = "PageNotFound")]
    PageNotFound(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other {
        error: SmolStr,
        message: Option<SmolStr>,
    },
}

impl core::fmt::Display for GetPageError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::PageNotFound(msg) => {
                write!(f, "PageNotFound")?;
                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.getPage
pub struct GetPageResponse;
impl jacquard_common::xrpc::XrpcResp for GetPageResponse {
    const NSID: &'static str = "sh.weaver.notebook.getPage";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = GetPageOutput<S>;
    type Err = GetPageError;
}

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

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

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

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

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

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

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

impl<S: BosStr, St> GetPageBuilder<S, St>
where
    St: get_page_state::State,
    St::Page: get_page_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> GetPage<S> {
        GetPage {
            page: self._fields.0.unwrap(),
        }
    }
}