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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: zone.stratos.defs
//
// This file was automatically generated from Lexicon schemas.
// Any manual changes will be overwritten on the next regeneration.

pub mod actor;
pub mod boundary;
pub mod enrollment;
pub mod feed;
pub mod repo;
pub mod sync;


#[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::{Did, AtUri, Cid};
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};
use crate::zone_stratos;
/// Indicates this record requires hydration from an external service. The stub record on the PDS contains minimal data; full content is fetched from the service endpoint.

#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct Source<'a> {
    ///DID of the hydration service, optionally with fragment identifying the service entry (e.g., 'did:plc:abc123#atproto_pns').
    #[serde(borrow)]
    pub service: Did<'a>,
    ///Reference to the full record at the hydration service.
    #[serde(borrow)]
    pub subject: zone_stratos::SubjectRef<'a>,
    ///Indicates when hydration is needed. 'authenticated' means full content requires viewer authentication.
    #[serde(borrow)]
    pub vary: SourceVary<'a>,
}

/// Indicates when hydration is needed. 'authenticated' means full content requires viewer authentication.

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum SourceVary<'a> {
    Authenticated,
    Unauthenticated,
    Other(CowStr<'a>),
}

impl<'a> SourceVary<'a> {
    pub fn as_str(&self) -> &str {
        match self {
            Self::Authenticated => "authenticated",
            Self::Unauthenticated => "unauthenticated",
            Self::Other(s) => s.as_ref(),
        }
    }
}

impl<'a> From<&'a str> for SourceVary<'a> {
    fn from(s: &'a str) -> Self {
        match s {
            "authenticated" => Self::Authenticated,
            "unauthenticated" => Self::Unauthenticated,
            _ => Self::Other(CowStr::from(s)),
        }
    }
}

impl<'a> From<String> for SourceVary<'a> {
    fn from(s: String) -> Self {
        match s.as_str() {
            "authenticated" => Self::Authenticated,
            "unauthenticated" => Self::Unauthenticated,
            _ => Self::Other(CowStr::from(s)),
        }
    }
}

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

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

impl<'a> serde::Serialize for SourceVary<'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 SourceVary<'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 SourceVary<'a> {
    fn default() -> Self {
        Self::Other(Default::default())
    }
}

impl jacquard_common::IntoStatic for SourceVary<'_> {
    type Output = SourceVary<'static>;
    fn into_static(self) -> Self::Output {
        match self {
            SourceVary::Authenticated => SourceVary::Authenticated,
            SourceVary::Unauthenticated => SourceVary::Unauthenticated,
            SourceVary::Other(v) => SourceVary::Other(v.into_static()),
        }
    }
}

/// A strong reference to a record, including its content hash for verification.

#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct SubjectRef<'a> {
    ///CID of the full record content for integrity verification.
    #[serde(borrow)]
    pub cid: Cid<'a>,
    ///AT-URI of the record at the hydration service.
    #[serde(borrow)]
    pub uri: AtUri<'a>,
}

impl<'a> LexiconSchema for Source<'a> {
    fn nsid() -> &'static str {
        "zone.stratos.defs"
    }
    fn def_name() -> &'static str {
        "source"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_zone_stratos_defs()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        {
            let value = &self.vary;
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 128usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("vary"),
                    max: 128usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        Ok(())
    }
}

impl<'a> LexiconSchema for SubjectRef<'a> {
    fn nsid() -> &'static str {
        "zone.stratos.defs"
    }
    fn def_name() -> &'static str {
        "subjectRef"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_zone_stratos_defs()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

pub mod source_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 Subject;
        type Vary;
        type Service;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Subject = Unset;
        type Vary = Unset;
        type Service = Unset;
    }
    ///State transition - sets the `subject` field to Set
    pub struct SetSubject<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetSubject<S> {}
    impl<S: State> State for SetSubject<S> {
        type Subject = Set<members::subject>;
        type Vary = S::Vary;
        type Service = S::Service;
    }
    ///State transition - sets the `vary` field to Set
    pub struct SetVary<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetVary<S> {}
    impl<S: State> State for SetVary<S> {
        type Subject = S::Subject;
        type Vary = Set<members::vary>;
        type Service = S::Service;
    }
    ///State transition - sets the `service` field to Set
    pub struct SetService<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetService<S> {}
    impl<S: State> State for SetService<S> {
        type Subject = S::Subject;
        type Vary = S::Vary;
        type Service = Set<members::service>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `subject` field
        pub struct subject(());
        ///Marker type for the `vary` field
        pub struct vary(());
        ///Marker type for the `service` field
        pub struct service(());
    }
}

/// Builder for constructing an instance of this type
pub struct SourceBuilder<'a, S: source_state::State> {
    _state: PhantomData<fn() -> S>,
    _fields: (
        Option<Did<'a>>,
        Option<zone_stratos::SubjectRef<'a>>,
        Option<SourceVary<'a>>,
    ),
    _lifetime: PhantomData<&'a ()>,
}

impl<'a> Source<'a> {
    /// Create a new builder for this type
    pub fn new() -> SourceBuilder<'a, source_state::Empty> {
        SourceBuilder::new()
    }
}

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

impl<'a, S> SourceBuilder<'a, S>
where
    S: source_state::State,
    S::Service: source_state::IsUnset,
{
    /// Set the `service` field (required)
    pub fn service(
        mut self,
        value: impl Into<Did<'a>>,
    ) -> SourceBuilder<'a, source_state::SetService<S>> {
        self._fields.0 = Option::Some(value.into());
        SourceBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> SourceBuilder<'a, S>
where
    S: source_state::State,
    S::Subject: source_state::IsUnset,
{
    /// Set the `subject` field (required)
    pub fn subject(
        mut self,
        value: impl Into<zone_stratos::SubjectRef<'a>>,
    ) -> SourceBuilder<'a, source_state::SetSubject<S>> {
        self._fields.1 = Option::Some(value.into());
        SourceBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> SourceBuilder<'a, S>
where
    S: source_state::State,
    S::Vary: source_state::IsUnset,
{
    /// Set the `vary` field (required)
    pub fn vary(
        mut self,
        value: impl Into<SourceVary<'a>>,
    ) -> SourceBuilder<'a, source_state::SetVary<S>> {
        self._fields.2 = Option::Some(value.into());
        SourceBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> SourceBuilder<'a, S>
where
    S: source_state::State,
    S::Subject: source_state::IsSet,
    S::Vary: source_state::IsSet,
    S::Service: source_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> Source<'a> {
        Source {
            service: self._fields.0.unwrap(),
            subject: self._fields.1.unwrap(),
            vary: 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>,
        >,
    ) -> Source<'a> {
        Source {
            service: self._fields.0.unwrap(),
            subject: self._fields.1.unwrap(),
            vary: self._fields.2.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_zone_stratos_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("zone.stratos.defs"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("source"),
                LexUserType::Object(LexObject {
                    description: Some(
                        CowStr::new_static(
                            "Indicates this record requires hydration from an external service. The stub record on the PDS contains minimal data; full content is fetched from the service endpoint.",
                        ),
                    ),
                    required: Some(
                        vec![
                            SmolStr::new_static("vary"), SmolStr::new_static("subject"),
                            SmolStr::new_static("service")
                        ],
                    ),
                    properties: {
                        #[allow(unused_mut)]
                        let mut map = BTreeMap::new();
                        map.insert(
                            SmolStr::new_static("service"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static(
                                        "DID of the hydration service, optionally with fragment identifying the service entry (e.g., 'did:plc:abc123#atproto_pns').",
                                    ),
                                ),
                                format: Some(LexStringFormat::Did),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("subject"),
                            LexObjectProperty::Ref(LexRef {
                                r#ref: CowStr::new_static("#subjectRef"),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("vary"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static(
                                        "Indicates when hydration is needed. 'authenticated' means full content requires viewer authentication.",
                                    ),
                                ),
                                max_length: Some(128usize),
                                ..Default::default()
                            }),
                        );
                        map
                    },
                    ..Default::default()
                }),
            );
            map.insert(
                SmolStr::new_static("subjectRef"),
                LexUserType::Object(LexObject {
                    description: Some(
                        CowStr::new_static(
                            "A strong reference to a record, including its content hash for verification.",
                        ),
                    ),
                    required: Some(
                        vec![SmolStr::new_static("uri"), SmolStr::new_static("cid")],
                    ),
                    properties: {
                        #[allow(unused_mut)]
                        let mut map = BTreeMap::new();
                        map.insert(
                            SmolStr::new_static("cid"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static(
                                        "CID of the full record content for integrity verification.",
                                    ),
                                ),
                                format: Some(LexStringFormat::Cid),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("uri"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static(
                                        "AT-URI of the record at the hydration service.",
                                    ),
                                ),
                                format: Some(LexStringFormat::AtUri),
                                ..Default::default()
                            }),
                        );
                        map
                    },
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}

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

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

impl<'a> SubjectRef<'a> {
    /// Create a new builder for this type
    pub fn new() -> SubjectRefBuilder<'a, subject_ref_state::Empty> {
        SubjectRefBuilder::new()
    }
}

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

impl<'a, S> SubjectRefBuilder<'a, S>
where
    S: subject_ref_state::State,
    S::Cid: subject_ref_state::IsUnset,
{
    /// Set the `cid` field (required)
    pub fn cid(
        mut self,
        value: impl Into<Cid<'a>>,
    ) -> SubjectRefBuilder<'a, subject_ref_state::SetCid<S>> {
        self._fields.0 = Option::Some(value.into());
        SubjectRefBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> SubjectRefBuilder<'a, S>
where
    S: subject_ref_state::State,
    S::Uri: subject_ref_state::IsUnset,
{
    /// Set the `uri` field (required)
    pub fn uri(
        mut self,
        value: impl Into<AtUri<'a>>,
    ) -> SubjectRefBuilder<'a, subject_ref_state::SetUri<S>> {
        self._fields.1 = Option::Some(value.into());
        SubjectRefBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> SubjectRefBuilder<'a, S>
where
    S: subject_ref_state::State,
    S::Uri: subject_ref_state::IsSet,
    S::Cid: subject_ref_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> SubjectRef<'a> {
        SubjectRef {
            cid: self._fields.0.unwrap(),
            uri: 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>,
        >,
    ) -> SubjectRef<'a> {
        SubjectRef {
            cid: self._fields.0.unwrap(),
            uri: self._fields.1.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}