jacquard-api 0.11.0

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: org.atsui.Caption
//
// 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::value::Data;
use jacquard_derive::{IntoStatic, lexicon};
use serde::{Serialize, Deserialize};
use crate::at_inlay::Response;

#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct Caption<'a> {
    #[serde(borrow)]
    pub children: Data<'a>,
}


#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct CaptionOutput<'a> {
    #[serde(flatten)]
    #[serde(borrow)]
    pub value: Response<'a>,
}

/// Response type for org.atsui.Caption
pub struct CaptionResponse;
impl jacquard_common::xrpc::XrpcResp for CaptionResponse {
    const NSID: &'static str = "org.atsui.Caption";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = CaptionOutput<'de>;
    type Err<'de> = jacquard_common::xrpc::GenericError<'de>;
}

impl<'a> jacquard_common::xrpc::XrpcRequest for Caption<'a> {
    const NSID: &'static str = "org.atsui.Caption";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = CaptionResponse;
}

/// Endpoint type for org.atsui.Caption
pub struct CaptionRequest;
impl jacquard_common::xrpc::XrpcEndpoint for CaptionRequest {
    const PATH: &'static str = "/xrpc/org.atsui.Caption";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Request<'de> = Caption<'de>;
    type Response = CaptionResponse;
}

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

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

impl<'a> Caption<'a> {
    /// Create a new builder for this type
    pub fn new() -> CaptionBuilder<'a, caption_state::Empty> {
        CaptionBuilder::new()
    }
}

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

impl<'a, S> CaptionBuilder<'a, S>
where
    S: caption_state::State,
    S::Children: caption_state::IsUnset,
{
    /// Set the `children` field (required)
    pub fn children(
        mut self,
        value: impl Into<Data<'a>>,
    ) -> CaptionBuilder<'a, caption_state::SetChildren<S>> {
        self._fields.0 = Option::Some(value.into());
        CaptionBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> CaptionBuilder<'a, S>
where
    S: caption_state::State,
    S::Children: caption_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> Caption<'a> {
        Caption {
            children: self._fields.0.unwrap(),
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data
    pub fn build_with_data(
        self,
        extra_data: BTreeMap<jacquard_common::deps::smol_str::SmolStr, Data<'a>>,
    ) -> Caption<'a> {
        Caption {
            children: self._fields.0.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}