jacquard_api/tools_ozone/set/
get_values.rs

1// @generated by jacquard-lexicon. DO NOT EDIT.
2//
3// Lexicon: tools.ozone.set.getValues
4//
5// This file was automatically generated from Lexicon schemas.
6// Any manual changes will be overwritten on the next regeneration.
7
8#[derive(
9    serde::Serialize,
10    serde::Deserialize,
11    Debug,
12    Clone,
13    PartialEq,
14    Eq,
15    jacquard_derive::IntoStatic
16)]
17#[serde(rename_all = "camelCase")]
18pub struct GetValues<'a> {
19    #[serde(skip_serializing_if = "std::option::Option::is_none")]
20    #[serde(borrow)]
21    pub cursor: std::option::Option<jacquard_common::CowStr<'a>>,
22    ///(default: 100, min: 1, max: 1000)
23    #[serde(skip_serializing_if = "std::option::Option::is_none")]
24    pub limit: std::option::Option<i64>,
25    #[serde(borrow)]
26    pub name: jacquard_common::CowStr<'a>,
27}
28
29pub mod get_values_state {
30
31    pub use crate::builder_types::{Set, Unset, IsSet, IsUnset};
32    #[allow(unused)]
33    use ::core::marker::PhantomData;
34    mod sealed {
35        pub trait Sealed {}
36    }
37    /// State trait tracking which required fields have been set
38    pub trait State: sealed::Sealed {
39        type Name;
40    }
41    /// Empty state - all required fields are unset
42    pub struct Empty(());
43    impl sealed::Sealed for Empty {}
44    impl State for Empty {
45        type Name = Unset;
46    }
47    ///State transition - sets the `name` field to Set
48    pub struct SetName<S: State = Empty>(PhantomData<fn() -> S>);
49    impl<S: State> sealed::Sealed for SetName<S> {}
50    impl<S: State> State for SetName<S> {
51        type Name = Set<members::name>;
52    }
53    /// Marker types for field names
54    #[allow(non_camel_case_types)]
55    pub mod members {
56        ///Marker type for the `name` field
57        pub struct name(());
58    }
59}
60
61/// Builder for constructing an instance of this type
62pub struct GetValuesBuilder<'a, S: get_values_state::State> {
63    _phantom_state: ::core::marker::PhantomData<fn() -> S>,
64    __unsafe_private_named: (
65        ::core::option::Option<jacquard_common::CowStr<'a>>,
66        ::core::option::Option<i64>,
67        ::core::option::Option<jacquard_common::CowStr<'a>>,
68    ),
69    _phantom: ::core::marker::PhantomData<&'a ()>,
70}
71
72impl<'a> GetValues<'a> {
73    /// Create a new builder for this type
74    pub fn new() -> GetValuesBuilder<'a, get_values_state::Empty> {
75        GetValuesBuilder::new()
76    }
77}
78
79impl<'a> GetValuesBuilder<'a, get_values_state::Empty> {
80    /// Create a new builder with all fields unset
81    pub fn new() -> Self {
82        GetValuesBuilder {
83            _phantom_state: ::core::marker::PhantomData,
84            __unsafe_private_named: (None, None, None),
85            _phantom: ::core::marker::PhantomData,
86        }
87    }
88}
89
90impl<'a, S: get_values_state::State> GetValuesBuilder<'a, S> {
91    /// Set the `cursor` field (optional)
92    pub fn cursor(
93        mut self,
94        value: impl Into<Option<jacquard_common::CowStr<'a>>>,
95    ) -> Self {
96        self.__unsafe_private_named.0 = value.into();
97        self
98    }
99    /// Set the `cursor` field to an Option value (optional)
100    pub fn maybe_cursor(mut self, value: Option<jacquard_common::CowStr<'a>>) -> Self {
101        self.__unsafe_private_named.0 = value;
102        self
103    }
104}
105
106impl<'a, S: get_values_state::State> GetValuesBuilder<'a, S> {
107    /// Set the `limit` field (optional)
108    pub fn limit(mut self, value: impl Into<Option<i64>>) -> Self {
109        self.__unsafe_private_named.1 = value.into();
110        self
111    }
112    /// Set the `limit` field to an Option value (optional)
113    pub fn maybe_limit(mut self, value: Option<i64>) -> Self {
114        self.__unsafe_private_named.1 = value;
115        self
116    }
117}
118
119impl<'a, S> GetValuesBuilder<'a, S>
120where
121    S: get_values_state::State,
122    S::Name: get_values_state::IsUnset,
123{
124    /// Set the `name` field (required)
125    pub fn name(
126        mut self,
127        value: impl Into<jacquard_common::CowStr<'a>>,
128    ) -> GetValuesBuilder<'a, get_values_state::SetName<S>> {
129        self.__unsafe_private_named.2 = ::core::option::Option::Some(value.into());
130        GetValuesBuilder {
131            _phantom_state: ::core::marker::PhantomData,
132            __unsafe_private_named: self.__unsafe_private_named,
133            _phantom: ::core::marker::PhantomData,
134        }
135    }
136}
137
138impl<'a, S> GetValuesBuilder<'a, S>
139where
140    S: get_values_state::State,
141    S::Name: get_values_state::IsSet,
142{
143    /// Build the final struct
144    pub fn build(self) -> GetValues<'a> {
145        GetValues {
146            cursor: self.__unsafe_private_named.0,
147            limit: self.__unsafe_private_named.1,
148            name: self.__unsafe_private_named.2.unwrap(),
149        }
150    }
151}
152
153#[jacquard_derive::lexicon]
154#[derive(
155    serde::Serialize,
156    serde::Deserialize,
157    Debug,
158    Clone,
159    PartialEq,
160    Eq,
161    jacquard_derive::IntoStatic
162)]
163#[serde(rename_all = "camelCase")]
164pub struct GetValuesOutput<'a> {
165    #[serde(skip_serializing_if = "std::option::Option::is_none")]
166    #[serde(borrow)]
167    pub cursor: std::option::Option<jacquard_common::CowStr<'a>>,
168    #[serde(borrow)]
169    pub set: crate::tools_ozone::set::SetView<'a>,
170    #[serde(borrow)]
171    pub values: Vec<jacquard_common::CowStr<'a>>,
172}
173
174#[jacquard_derive::open_union]
175#[derive(
176    serde::Serialize,
177    serde::Deserialize,
178    Debug,
179    Clone,
180    PartialEq,
181    Eq,
182    thiserror::Error,
183    miette::Diagnostic,
184    jacquard_derive::IntoStatic
185)]
186#[serde(tag = "error", content = "message")]
187#[serde(bound(deserialize = "'de: 'a"))]
188pub enum GetValuesError<'a> {
189    /// set with the given name does not exist
190    #[serde(rename = "SetNotFound")]
191    SetNotFound(std::option::Option<String>),
192}
193
194impl std::fmt::Display for GetValuesError<'_> {
195    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
196        match self {
197            Self::SetNotFound(msg) => {
198                write!(f, "SetNotFound")?;
199                if let Some(msg) = msg {
200                    write!(f, ": {}", msg)?;
201                }
202                Ok(())
203            }
204            Self::Unknown(err) => write!(f, "Unknown error: {:?}", err),
205        }
206    }
207}
208
209/// Response type for
210///tools.ozone.set.getValues
211pub struct GetValuesResponse;
212impl jacquard_common::xrpc::XrpcResp for GetValuesResponse {
213    const NSID: &'static str = "tools.ozone.set.getValues";
214    const ENCODING: &'static str = "application/json";
215    type Output<'de> = GetValuesOutput<'de>;
216    type Err<'de> = GetValuesError<'de>;
217}
218
219impl<'a> jacquard_common::xrpc::XrpcRequest for GetValues<'a> {
220    const NSID: &'static str = "tools.ozone.set.getValues";
221    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
222    type Response = GetValuesResponse;
223}
224
225/// Endpoint type for
226///tools.ozone.set.getValues
227pub struct GetValuesRequest;
228impl jacquard_common::xrpc::XrpcEndpoint for GetValuesRequest {
229    const PATH: &'static str = "/xrpc/tools.ozone.set.getValues";
230    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
231    type Request<'de> = GetValues<'de>;
232    type Response = GetValuesResponse;
233}