jacquard-api 0.11.0

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
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: blue.2048.key.defs
//
// This file was automatically generated from Lexicon schemas.
// Any manual changes will be overwritten on the next regeneration.

pub mod game;
pub mod player;


#[allow(unused_imports)]
use alloc::collections::BTreeMap;

#[allow(unused_imports)]
use core::marker::PhantomData;
use jacquard_common::CowStr;

#[allow(unused_imports)]
use jacquard_common::deps::codegen::unicode_segmentation::UnicodeSegmentation;
use jacquard_common::types::string::Datetime;
use jacquard_derive::{IntoStatic, lexicon};
use jacquard_lexicon::lexicon::LexiconDoc;
use jacquard_lexicon::schema::LexiconSchema;

#[allow(unused_imports)]
use jacquard_lexicon::validation::{ConstraintError, ValidationPath};
use serde::{Serialize, Deserialize};
/// A record that holds a did:key used to verify records. Use the collection to know the type of verification. Example blue.2048.key.game is for blue.2048.game records

#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct Key<'a> {
    pub created_at: Datetime,
    ///A did:key used to verify records came from an at://2048 authority
    #[serde(borrow)]
    pub key: CowStr<'a>,
}

/// a signature for an at://2048 record meaning it has been verified by a service. Most likely @2048.blue

#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct SignatureRef<'a> {
    ///The at://uri for the public did:key to verify this record. This also counts as the authority of the verification (example @2048.blue). As well as the type of verification by the collection name (blue.2048.key.game).
    #[serde(borrow)]
    pub at_uri: CowStr<'a>,
    pub created_at: Datetime,
    ///The public verifiable signature of the record. Serialization of the records value minus the signature field
    #[serde(borrow)]
    pub signature: CowStr<'a>,
}

impl<'a> LexiconSchema for Key<'a> {
    fn nsid() -> &'static str {
        "blue.2048.key.defs"
    }
    fn def_name() -> &'static str {
        "key"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_blue_2048_key_defs()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

impl<'a> LexiconSchema for SignatureRef<'a> {
    fn nsid() -> &'static str {
        "blue.2048.key.defs"
    }
    fn def_name() -> &'static str {
        "signatureRef"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_blue_2048_key_defs()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

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

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

impl<'a> Key<'a> {
    /// Create a new builder for this type
    pub fn new() -> KeyBuilder<'a, key_state::Empty> {
        KeyBuilder::new()
    }
}

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

impl<'a, S> KeyBuilder<'a, S>
where
    S: key_state::State,
    S::CreatedAt: key_state::IsUnset,
{
    /// Set the `createdAt` field (required)
    pub fn created_at(
        mut self,
        value: impl Into<Datetime>,
    ) -> KeyBuilder<'a, key_state::SetCreatedAt<S>> {
        self._fields.0 = Option::Some(value.into());
        KeyBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> KeyBuilder<'a, S>
where
    S: key_state::State,
    S::Key: key_state::IsUnset,
{
    /// Set the `key` field (required)
    pub fn key(
        mut self,
        value: impl Into<CowStr<'a>>,
    ) -> KeyBuilder<'a, key_state::SetKey<S>> {
        self._fields.1 = Option::Some(value.into());
        KeyBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> KeyBuilder<'a, S>
where
    S: key_state::State,
    S::CreatedAt: key_state::IsSet,
    S::Key: key_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> Key<'a> {
        Key {
            created_at: self._fields.0.unwrap(),
            key: self._fields.1.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,
            jacquard_common::types::value::Data<'a>,
        >,
    ) -> Key<'a> {
        Key {
            created_at: self._fields.0.unwrap(),
            key: self._fields.1.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_blue_2048_key_defs() -> LexiconDoc<'static> {
    #[allow(unused_imports)]
    use jacquard_common::{CowStr, deps::smol_str::SmolStr, types::blob::MimeType};
    use jacquard_lexicon::lexicon::*;
    use alloc::collections::BTreeMap;
    LexiconDoc {
        lexicon: Lexicon::Lexicon1,
        id: CowStr::new_static("blue.2048.key.defs"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("key"),
                LexUserType::Object(LexObject {
                    description: Some(
                        CowStr::new_static(
                            "A record that holds a did:key used to verify records. Use the collection to know the type of verification. Example blue.2048.key.game is for blue.2048.game records",
                        ),
                    ),
                    required: Some(
                        vec![
                            SmolStr::new_static("key"), SmolStr::new_static("createdAt")
                        ],
                    ),
                    properties: {
                        #[allow(unused_mut)]
                        let mut map = BTreeMap::new();
                        map.insert(
                            SmolStr::new_static("createdAt"),
                            LexObjectProperty::String(LexString {
                                format: Some(LexStringFormat::Datetime),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("key"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static(
                                        "A did:key used to verify records came from an at://2048 authority",
                                    ),
                                ),
                                ..Default::default()
                            }),
                        );
                        map
                    },
                    ..Default::default()
                }),
            );
            map.insert(
                SmolStr::new_static("signatureRef"),
                LexUserType::Object(LexObject {
                    description: Some(
                        CowStr::new_static(
                            "a signature for an at://2048 record meaning it has been verified by a service. Most likely @2048.blue",
                        ),
                    ),
                    required: Some(
                        vec![
                            SmolStr::new_static("atURI"),
                            SmolStr::new_static("signature"),
                            SmolStr::new_static("createdAt")
                        ],
                    ),
                    properties: {
                        #[allow(unused_mut)]
                        let mut map = BTreeMap::new();
                        map.insert(
                            SmolStr::new_static("atURI"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static(
                                        "The at://uri for the public did:key to verify this record. This also counts as the authority of the verification (example @2048.blue). As well as the type of verification by the collection name (blue.2048.key.game).",
                                    ),
                                ),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("createdAt"),
                            LexObjectProperty::String(LexString {
                                format: Some(LexStringFormat::Datetime),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("signature"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static(
                                        "The public verifiable signature of the record. Serialization of the records value minus the signature field",
                                    ),
                                ),
                                ..Default::default()
                            }),
                        );
                        map
                    },
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}

pub mod signature_ref_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 AtUri;
        type Signature;
        type CreatedAt;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type AtUri = Unset;
        type Signature = Unset;
        type CreatedAt = Unset;
    }
    ///State transition - sets the `at_uri` field to Set
    pub struct SetAtUri<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetAtUri<S> {}
    impl<S: State> State for SetAtUri<S> {
        type AtUri = Set<members::at_uri>;
        type Signature = S::Signature;
        type CreatedAt = S::CreatedAt;
    }
    ///State transition - sets the `signature` field to Set
    pub struct SetSignature<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetSignature<S> {}
    impl<S: State> State for SetSignature<S> {
        type AtUri = S::AtUri;
        type Signature = Set<members::signature>;
        type CreatedAt = S::CreatedAt;
    }
    ///State transition - sets the `created_at` field to Set
    pub struct SetCreatedAt<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetCreatedAt<S> {}
    impl<S: State> State for SetCreatedAt<S> {
        type AtUri = S::AtUri;
        type Signature = S::Signature;
        type CreatedAt = Set<members::created_at>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `at_uri` field
        pub struct at_uri(());
        ///Marker type for the `signature` field
        pub struct signature(());
        ///Marker type for the `created_at` field
        pub struct created_at(());
    }
}

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

impl<'a> SignatureRef<'a> {
    /// Create a new builder for this type
    pub fn new() -> SignatureRefBuilder<'a, signature_ref_state::Empty> {
        SignatureRefBuilder::new()
    }
}

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

impl<'a, S> SignatureRefBuilder<'a, S>
where
    S: signature_ref_state::State,
    S::AtUri: signature_ref_state::IsUnset,
{
    /// Set the `atURI` field (required)
    pub fn at_uri(
        mut self,
        value: impl Into<CowStr<'a>>,
    ) -> SignatureRefBuilder<'a, signature_ref_state::SetAtUri<S>> {
        self._fields.0 = Option::Some(value.into());
        SignatureRefBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> SignatureRefBuilder<'a, S>
where
    S: signature_ref_state::State,
    S::CreatedAt: signature_ref_state::IsUnset,
{
    /// Set the `createdAt` field (required)
    pub fn created_at(
        mut self,
        value: impl Into<Datetime>,
    ) -> SignatureRefBuilder<'a, signature_ref_state::SetCreatedAt<S>> {
        self._fields.1 = Option::Some(value.into());
        SignatureRefBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

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

impl<'a, S> SignatureRefBuilder<'a, S>
where
    S: signature_ref_state::State,
    S::AtUri: signature_ref_state::IsSet,
    S::Signature: signature_ref_state::IsSet,
    S::CreatedAt: signature_ref_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> SignatureRef<'a> {
        SignatureRef {
            at_uri: self._fields.0.unwrap(),
            created_at: self._fields.1.unwrap(),
            signature: self._fields.2.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,
            jacquard_common::types::value::Data<'a>,
        >,
    ) -> SignatureRef<'a> {
        SignatureRef {
            at_uri: self._fields.0.unwrap(),
            created_at: self._fields.1.unwrap(),
            signature: self._fields.2.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}