jacquard-api 0.11.1

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: tools.ozone.set.getValues
//
// 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;
use jacquard_derive::{IntoStatic, lexicon, open_union};
use serde::{Serialize, Deserialize};
use crate::tools_ozone::set::SetView;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct GetValues<'a> {
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub cursor: Option<CowStr<'a>>,
    ///Defaults to `100`. Min: 1. Max: 1000.
    #[serde(default = "_default_limit")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
    #[serde(borrow)]
    pub name: CowStr<'a>,
}


#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct GetValuesOutput<'a> {
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub cursor: Option<CowStr<'a>>,
    #[serde(borrow)]
    pub set: SetView<'a>,
    #[serde(borrow)]
    pub values: Vec<CowStr<'a>>,
}


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

#[serde(tag = "error", content = "message")]
#[serde(bound(deserialize = "'de: 'a"))]
pub enum GetValuesError<'a> {
    /// set with the given name does not exist
    #[serde(rename = "SetNotFound")]
    SetNotFound(Option<CowStr<'a>>),
}

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

/// Response type for tools.ozone.set.getValues
pub struct GetValuesResponse;
impl jacquard_common::xrpc::XrpcResp for GetValuesResponse {
    const NSID: &'static str = "tools.ozone.set.getValues";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = GetValuesOutput<'de>;
    type Err<'de> = GetValuesError<'de>;
}

impl<'a> jacquard_common::xrpc::XrpcRequest for GetValues<'a> {
    const NSID: &'static str = "tools.ozone.set.getValues";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetValuesResponse;
}

/// Endpoint type for tools.ozone.set.getValues
pub struct GetValuesRequest;
impl jacquard_common::xrpc::XrpcEndpoint for GetValuesRequest {
    const PATH: &'static str = "/xrpc/tools.ozone.set.getValues";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<'de> = GetValues<'de>;
    type Response = GetValuesResponse;
}

fn _default_limit() -> Option<i64> {
    Some(100i64)
}

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

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

impl<'a> GetValues<'a> {
    /// Create a new builder for this type
    pub fn new() -> GetValuesBuilder<'a, get_values_state::Empty> {
        GetValuesBuilder::new()
    }
}

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

impl<'a, S: get_values_state::State> GetValuesBuilder<'a, S> {
    /// Set the `cursor` field (optional)
    pub fn cursor(mut self, value: impl Into<Option<CowStr<'a>>>) -> Self {
        self._fields.0 = value.into();
        self
    }
    /// Set the `cursor` field to an Option value (optional)
    pub fn maybe_cursor(mut self, value: Option<CowStr<'a>>) -> Self {
        self._fields.0 = value;
        self
    }
}

impl<'a, S: get_values_state::State> GetValuesBuilder<'a, S> {
    /// Set the `limit` field (optional)
    pub fn limit(mut self, value: impl Into<Option<i64>>) -> Self {
        self._fields.1 = value.into();
        self
    }
    /// Set the `limit` field to an Option value (optional)
    pub fn maybe_limit(mut self, value: Option<i64>) -> Self {
        self._fields.1 = value;
        self
    }
}

impl<'a, S> GetValuesBuilder<'a, S>
where
    S: get_values_state::State,
    S::Name: get_values_state::IsUnset,
{
    /// Set the `name` field (required)
    pub fn name(
        mut self,
        value: impl Into<CowStr<'a>>,
    ) -> GetValuesBuilder<'a, get_values_state::SetName<S>> {
        self._fields.2 = Option::Some(value.into());
        GetValuesBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> GetValuesBuilder<'a, S>
where
    S: get_values_state::State,
    S::Name: get_values_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> GetValues<'a> {
        GetValues {
            cursor: self._fields.0,
            limit: self._fields.1,
            name: self._fields.2.unwrap(),
        }
    }
}