jacquard-api 0.11.1

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: sh.weaver.notebook.getPublishedVersions
//
// 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::types::string::AtUri;
use jacquard_common::types::value::Data;
use jacquard_derive::{IntoStatic, lexicon};
use serde::{Serialize, Deserialize};
use crate::sh_weaver::notebook::PublishedVersionView;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct GetPublishedVersions<'a> {
    #[serde(borrow)]
    pub entry: AtUri<'a>,
    /// Defaults to `false`.
    #[serde(default = "_default_include_content")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub include_content: Option<bool>,
}


#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct GetPublishedVersionsOutput<'a> {
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub canonical: Option<PublishedVersionView<'a>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub has_divergence: Option<bool>,
    ///Full entry records if includeContent=true
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub records: Option<Vec<Data<'a>>>,
    #[serde(borrow)]
    pub versions: Vec<PublishedVersionView<'a>>,
}

/// Response type for sh.weaver.notebook.getPublishedVersions
pub struct GetPublishedVersionsResponse;
impl jacquard_common::xrpc::XrpcResp for GetPublishedVersionsResponse {
    const NSID: &'static str = "sh.weaver.notebook.getPublishedVersions";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = GetPublishedVersionsOutput<'de>;
    type Err<'de> = jacquard_common::xrpc::GenericError<'de>;
}

impl<'a> jacquard_common::xrpc::XrpcRequest for GetPublishedVersions<'a> {
    const NSID: &'static str = "sh.weaver.notebook.getPublishedVersions";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetPublishedVersionsResponse;
}

/// Endpoint type for sh.weaver.notebook.getPublishedVersions
pub struct GetPublishedVersionsRequest;
impl jacquard_common::xrpc::XrpcEndpoint for GetPublishedVersionsRequest {
    const PATH: &'static str = "/xrpc/sh.weaver.notebook.getPublishedVersions";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<'de> = GetPublishedVersions<'de>;
    type Response = GetPublishedVersionsResponse;
}

fn _default_include_content() -> Option<bool> {
    Some(false)
}

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

/// Builder for constructing an instance of this type
pub struct GetPublishedVersionsBuilder<'a, S: get_published_versions_state::State> {
    _state: PhantomData<fn() -> S>,
    _fields: (Option<AtUri<'a>>, Option<bool>),
    _lifetime: PhantomData<&'a ()>,
}

impl<'a> GetPublishedVersions<'a> {
    /// Create a new builder for this type
    pub fn new() -> GetPublishedVersionsBuilder<
        'a,
        get_published_versions_state::Empty,
    > {
        GetPublishedVersionsBuilder::new()
    }
}

impl<'a> GetPublishedVersionsBuilder<'a, get_published_versions_state::Empty> {
    /// Create a new builder with all fields unset
    pub fn new() -> Self {
        GetPublishedVersionsBuilder {
            _state: PhantomData,
            _fields: (None, None),
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> GetPublishedVersionsBuilder<'a, S>
where
    S: get_published_versions_state::State,
    S::Entry: get_published_versions_state::IsUnset,
{
    /// Set the `entry` field (required)
    pub fn entry(
        mut self,
        value: impl Into<AtUri<'a>>,
    ) -> GetPublishedVersionsBuilder<'a, get_published_versions_state::SetEntry<S>> {
        self._fields.0 = Option::Some(value.into());
        GetPublishedVersionsBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S: get_published_versions_state::State> GetPublishedVersionsBuilder<'a, S> {
    /// Set the `includeContent` field (optional)
    pub fn include_content(mut self, value: impl Into<Option<bool>>) -> Self {
        self._fields.1 = value.into();
        self
    }
    /// Set the `includeContent` field to an Option value (optional)
    pub fn maybe_include_content(mut self, value: Option<bool>) -> Self {
        self._fields.1 = value;
        self
    }
}

impl<'a, S> GetPublishedVersionsBuilder<'a, S>
where
    S: get_published_versions_state::State,
    S::Entry: get_published_versions_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> GetPublishedVersions<'a> {
        GetPublishedVersions {
            entry: self._fields.0.unwrap(),
            include_content: self._fields.1,
        }
    }
}