jacquard-api 0.12.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

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.stream.broadcast.getBroadcaster
//
// 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::{BosStr, DefaultStr, FromStaticStr};
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::string::Did;
use jacquard_common::types::value::Data;
use jacquard_derive::IntoStatic;
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct GetBroadcaster;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetBroadcasterOutput<S: BosStr = DefaultStr> {
    ///Array of DIDs authorized as admins
    #[serde(skip_serializing_if = "Option::is_none")]
    pub admins: Option<Vec<Did<S>>>,
    ///DID of the Streamplace broadcaster to which this server belongs
    pub broadcaster: Did<S>,
    ///DID of this particular Streamplace server
    #[serde(skip_serializing_if = "Option::is_none")]
    pub server: Option<Did<S>>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}


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

#[serde(tag = "error", content = "message")]
pub enum GetBroadcasterError {
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other { error: SmolStr, message: Option<SmolStr> },
}

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

/** Response marker for the `place.stream.broadcast.getBroadcaster` query.

Implements `jacquard_common::xrpc::XrpcResp`; successful bodies decode as `Self::Output<S>`, which is `GetBroadcasterOutput<S>` for this endpoint.*/
pub struct GetBroadcasterResponse;
impl jacquard_common::xrpc::XrpcResp for GetBroadcasterResponse {
    const NSID: &'static str = "place.stream.broadcast.getBroadcaster";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = GetBroadcasterOutput<S>;
    type Err = GetBroadcasterError;
}

impl jacquard_common::xrpc::XrpcRequest for GetBroadcaster {
    const NSID: &'static str = "place.stream.broadcast.getBroadcaster";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetBroadcasterResponse;
}

/** Endpoint marker for the `place.stream.broadcast.getBroadcaster` query.

Path: `/xrpc/place.stream.broadcast.getBroadcaster`. The request payload type is `GetBroadcaster`; send that request with `jacquard::Client` or use this marker through lower-level `XrpcEndpoint` APIs.*/
pub struct GetBroadcasterRequest;
impl jacquard_common::xrpc::XrpcEndpoint for GetBroadcasterRequest {
    const PATH: &'static str = "/xrpc/place.stream.broadcast.getBroadcaster";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<S: BosStr> = GetBroadcaster;
    type Response = GetBroadcasterResponse;
}