jacquard-api 0.10.2

Generated AT Protocol API bindings for Jacquard
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: com.atproto.repo.createRecord
//
// This file was automatically generated from Lexicon schemas.
// Any manual changes will be overwritten on the next regeneration.

#[jacquard_derive::lexicon]
#[derive(
    serde::Serialize,
    serde::Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    jacquard_derive::IntoStatic
)]
#[serde(rename_all = "camelCase")]
pub struct CreateRecord<'a> {
    ///The NSID of the record collection.
    #[serde(borrow)]
    pub collection: jacquard_common::types::string::Nsid<'a>,
    ///The record itself. Must contain a $type field.
    #[serde(borrow)]
    pub record: jacquard_common::types::value::Data<'a>,
    ///The handle or DID of the repo (aka, current account).
    #[serde(borrow)]
    pub repo: jacquard_common::types::ident::AtIdentifier<'a>,
    ///The Record Key.
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub rkey: std::option::Option<
        jacquard_common::types::string::RecordKey<
            jacquard_common::types::string::Rkey<'a>,
        >,
    >,
    ///Compare and swap with the previous commit by CID.
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub swap_commit: std::option::Option<jacquard_common::types::string::Cid<'a>>,
    ///Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons.
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    pub validate: std::option::Option<bool>,
}

pub mod create_record_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 Collection;
        type Record;
        type Repo;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Collection = Unset;
        type Record = Unset;
        type Repo = Unset;
    }
    ///State transition - sets the `collection` field to Set
    pub struct SetCollection<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetCollection<S> {}
    impl<S: State> State for SetCollection<S> {
        type Collection = Set<members::collection>;
        type Record = S::Record;
        type Repo = S::Repo;
    }
    ///State transition - sets the `record` field to Set
    pub struct SetRecord<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetRecord<S> {}
    impl<S: State> State for SetRecord<S> {
        type Collection = S::Collection;
        type Record = Set<members::record>;
        type Repo = S::Repo;
    }
    ///State transition - sets the `repo` field to Set
    pub struct SetRepo<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetRepo<S> {}
    impl<S: State> State for SetRepo<S> {
        type Collection = S::Collection;
        type Record = S::Record;
        type Repo = Set<members::repo>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `collection` field
        pub struct collection(());
        ///Marker type for the `record` field
        pub struct record(());
        ///Marker type for the `repo` field
        pub struct repo(());
    }
}

/// Builder for constructing an instance of this type
pub struct CreateRecordBuilder<'a, S: create_record_state::State> {
    _phantom_state: ::core::marker::PhantomData<fn() -> S>,
    __unsafe_private_named: (
        ::core::option::Option<jacquard_common::types::string::Nsid<'a>>,
        ::core::option::Option<jacquard_common::types::value::Data<'a>>,
        ::core::option::Option<jacquard_common::types::ident::AtIdentifier<'a>>,
        ::core::option::Option<
            jacquard_common::types::string::RecordKey<
                jacquard_common::types::string::Rkey<'a>,
            >,
        >,
        ::core::option::Option<jacquard_common::types::string::Cid<'a>>,
        ::core::option::Option<bool>,
    ),
    _phantom: ::core::marker::PhantomData<&'a ()>,
}

impl<'a> CreateRecord<'a> {
    /// Create a new builder for this type
    pub fn new() -> CreateRecordBuilder<'a, create_record_state::Empty> {
        CreateRecordBuilder::new()
    }
}

impl<'a> CreateRecordBuilder<'a, create_record_state::Empty> {
    /// Create a new builder with all fields unset
    pub fn new() -> Self {
        CreateRecordBuilder {
            _phantom_state: ::core::marker::PhantomData,
            __unsafe_private_named: (None, None, None, None, None, None),
            _phantom: ::core::marker::PhantomData,
        }
    }
}

impl<'a, S> CreateRecordBuilder<'a, S>
where
    S: create_record_state::State,
    S::Collection: create_record_state::IsUnset,
{
    /// Set the `collection` field (required)
    pub fn collection(
        mut self,
        value: impl Into<jacquard_common::types::string::Nsid<'a>>,
    ) -> CreateRecordBuilder<'a, create_record_state::SetCollection<S>> {
        self.__unsafe_private_named.0 = ::core::option::Option::Some(value.into());
        CreateRecordBuilder {
            _phantom_state: ::core::marker::PhantomData,
            __unsafe_private_named: self.__unsafe_private_named,
            _phantom: ::core::marker::PhantomData,
        }
    }
}

impl<'a, S> CreateRecordBuilder<'a, S>
where
    S: create_record_state::State,
    S::Record: create_record_state::IsUnset,
{
    /// Set the `record` field (required)
    pub fn record(
        mut self,
        value: impl Into<jacquard_common::types::value::Data<'a>>,
    ) -> CreateRecordBuilder<'a, create_record_state::SetRecord<S>> {
        self.__unsafe_private_named.1 = ::core::option::Option::Some(value.into());
        CreateRecordBuilder {
            _phantom_state: ::core::marker::PhantomData,
            __unsafe_private_named: self.__unsafe_private_named,
            _phantom: ::core::marker::PhantomData,
        }
    }
}

impl<'a, S> CreateRecordBuilder<'a, S>
where
    S: create_record_state::State,
    S::Repo: create_record_state::IsUnset,
{
    /// Set the `repo` field (required)
    pub fn repo(
        mut self,
        value: impl Into<jacquard_common::types::ident::AtIdentifier<'a>>,
    ) -> CreateRecordBuilder<'a, create_record_state::SetRepo<S>> {
        self.__unsafe_private_named.2 = ::core::option::Option::Some(value.into());
        CreateRecordBuilder {
            _phantom_state: ::core::marker::PhantomData,
            __unsafe_private_named: self.__unsafe_private_named,
            _phantom: ::core::marker::PhantomData,
        }
    }
}

impl<'a, S: create_record_state::State> CreateRecordBuilder<'a, S> {
    /// Set the `rkey` field (optional)
    pub fn rkey(
        mut self,
        value: impl Into<
            Option<
                jacquard_common::types::string::RecordKey<
                    jacquard_common::types::string::Rkey<'a>,
                >,
            >,
        >,
    ) -> Self {
        self.__unsafe_private_named.3 = value.into();
        self
    }
    /// Set the `rkey` field to an Option value (optional)
    pub fn maybe_rkey(
        mut self,
        value: Option<
            jacquard_common::types::string::RecordKey<
                jacquard_common::types::string::Rkey<'a>,
            >,
        >,
    ) -> Self {
        self.__unsafe_private_named.3 = value;
        self
    }
}

impl<'a, S: create_record_state::State> CreateRecordBuilder<'a, S> {
    /// Set the `swapCommit` field (optional)
    pub fn swap_commit(
        mut self,
        value: impl Into<Option<jacquard_common::types::string::Cid<'a>>>,
    ) -> Self {
        self.__unsafe_private_named.4 = value.into();
        self
    }
    /// Set the `swapCommit` field to an Option value (optional)
    pub fn maybe_swap_commit(
        mut self,
        value: Option<jacquard_common::types::string::Cid<'a>>,
    ) -> Self {
        self.__unsafe_private_named.4 = value;
        self
    }
}

impl<'a, S: create_record_state::State> CreateRecordBuilder<'a, S> {
    /// Set the `validate` field (optional)
    pub fn validate(mut self, value: impl Into<Option<bool>>) -> Self {
        self.__unsafe_private_named.5 = value.into();
        self
    }
    /// Set the `validate` field to an Option value (optional)
    pub fn maybe_validate(mut self, value: Option<bool>) -> Self {
        self.__unsafe_private_named.5 = value;
        self
    }
}

impl<'a, S> CreateRecordBuilder<'a, S>
where
    S: create_record_state::State,
    S::Collection: create_record_state::IsSet,
    S::Record: create_record_state::IsSet,
    S::Repo: create_record_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> CreateRecord<'a> {
        CreateRecord {
            collection: self.__unsafe_private_named.0.unwrap(),
            record: self.__unsafe_private_named.1.unwrap(),
            repo: self.__unsafe_private_named.2.unwrap(),
            rkey: self.__unsafe_private_named.3,
            swap_commit: self.__unsafe_private_named.4,
            validate: self.__unsafe_private_named.5,
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data
    pub fn build_with_data(
        self,
        extra_data: std::collections::BTreeMap<
            jacquard_common::deps::smol_str::SmolStr,
            jacquard_common::types::value::Data<'a>,
        >,
    ) -> CreateRecord<'a> {
        CreateRecord {
            collection: self.__unsafe_private_named.0.unwrap(),
            record: self.__unsafe_private_named.1.unwrap(),
            repo: self.__unsafe_private_named.2.unwrap(),
            rkey: self.__unsafe_private_named.3,
            swap_commit: self.__unsafe_private_named.4,
            validate: self.__unsafe_private_named.5,
            extra_data: Some(extra_data),
        }
    }
}

#[jacquard_derive::lexicon]
#[derive(
    serde::Serialize,
    serde::Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    jacquard_derive::IntoStatic
)]
#[serde(rename_all = "camelCase")]
pub struct CreateRecordOutput<'a> {
    #[serde(borrow)]
    pub cid: jacquard_common::types::string::Cid<'a>,
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub commit: std::option::Option<crate::com_atproto::repo::CommitMeta<'a>>,
    #[serde(borrow)]
    pub uri: jacquard_common::types::string::AtUri<'a>,
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub validation_status: std::option::Option<CreateRecordOutputValidationStatus<'a>>,
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum CreateRecordOutputValidationStatus<'a> {
    Valid,
    Unknown,
    Other(jacquard_common::CowStr<'a>),
}

impl<'a> CreateRecordOutputValidationStatus<'a> {
    pub fn as_str(&self) -> &str {
        match self {
            Self::Valid => "valid",
            Self::Unknown => "unknown",
            Self::Other(s) => s.as_ref(),
        }
    }
}

impl<'a> From<&'a str> for CreateRecordOutputValidationStatus<'a> {
    fn from(s: &'a str) -> Self {
        match s {
            "valid" => Self::Valid,
            "unknown" => Self::Unknown,
            _ => Self::Other(jacquard_common::CowStr::from(s)),
        }
    }
}

impl<'a> From<String> for CreateRecordOutputValidationStatus<'a> {
    fn from(s: String) -> Self {
        match s.as_str() {
            "valid" => Self::Valid,
            "unknown" => Self::Unknown,
            _ => Self::Other(jacquard_common::CowStr::from(s)),
        }
    }
}

impl<'a> core::fmt::Display for CreateRecordOutputValidationStatus<'a> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "{}", self.as_str())
    }
}

impl<'a> AsRef<str> for CreateRecordOutputValidationStatus<'a> {
    fn as_ref(&self) -> &str {
        self.as_str()
    }
}

impl<'a> serde::Serialize for CreateRecordOutputValidationStatus<'a> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serializer.serialize_str(self.as_str())
    }
}

impl<'de, 'a> serde::Deserialize<'de> for CreateRecordOutputValidationStatus<'a>
where
    'de: 'a,
{
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let s = <&'de str>::deserialize(deserializer)?;
        Ok(Self::from(s))
    }
}

impl<'a> Default for CreateRecordOutputValidationStatus<'a> {
    fn default() -> Self {
        Self::Other(Default::default())
    }
}

impl jacquard_common::IntoStatic for CreateRecordOutputValidationStatus<'_> {
    type Output = CreateRecordOutputValidationStatus<'static>;
    fn into_static(self) -> Self::Output {
        match self {
            CreateRecordOutputValidationStatus::Valid => {
                CreateRecordOutputValidationStatus::Valid
            }
            CreateRecordOutputValidationStatus::Unknown => {
                CreateRecordOutputValidationStatus::Unknown
            }
            CreateRecordOutputValidationStatus::Other(v) => {
                CreateRecordOutputValidationStatus::Other(v.into_static())
            }
        }
    }
}

#[jacquard_derive::open_union]
#[derive(
    serde::Serialize,
    serde::Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    thiserror::Error,
    miette::Diagnostic,
    jacquard_derive::IntoStatic
)]
#[serde(tag = "error", content = "message")]
#[serde(bound(deserialize = "'de: 'a"))]
pub enum CreateRecordError<'a> {
    /// Indicates that 'swapCommit' didn't match current repo commit.
    #[serde(rename = "InvalidSwap")]
    InvalidSwap(std::option::Option<jacquard_common::CowStr<'a>>),
}

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

/// Response type for
///com.atproto.repo.createRecord
pub struct CreateRecordResponse;
impl jacquard_common::xrpc::XrpcResp for CreateRecordResponse {
    const NSID: &'static str = "com.atproto.repo.createRecord";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = CreateRecordOutput<'de>;
    type Err<'de> = CreateRecordError<'de>;
}

impl<'a> jacquard_common::xrpc::XrpcRequest for CreateRecord<'a> {
    const NSID: &'static str = "com.atproto.repo.createRecord";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = CreateRecordResponse;
}

/// Endpoint type for
///com.atproto.repo.createRecord
pub struct CreateRecordRequest;
impl jacquard_common::xrpc::XrpcEndpoint for CreateRecordRequest {
    const PATH: &'static str = "/xrpc/com.atproto.repo.createRecord";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Request<'de> = CreateRecord<'de>;
    type Response = CreateRecordResponse;
}