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

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.stream.server.getStorage
//
// 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::value::Data;
use jacquard_derive::IntoStatic;
use serde::{Serialize, Deserialize};
use crate::place_stream::server::Storage;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic, Default)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetStorageOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub storage: Option<Storage<S>>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/** Request marker for the `place.stream.server.getStorage` query.

This endpoint has no request parameters or input body; send this marker with `jacquard::Client`.*/

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic, Copy)]
pub struct GetStorage;
/** Response marker for the `place.stream.server.getStorage` query.

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

impl jacquard_common::xrpc::XrpcRequest for GetStorage {
    const NSID: &'static str = "place.stream.server.getStorage";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetStorageResponse;
}

/** Endpoint marker for the `place.stream.server.getStorage` query.

Path: `/xrpc/place.stream.server.getStorage`. The request payload type is `GetStorage`; use this marker with lower-level `XrpcEndpoint` APIs when you need endpoint metadata.*/
pub struct GetStorageRequest;
impl jacquard_common::xrpc::XrpcEndpoint for GetStorageRequest {
    const PATH: &'static str = "/xrpc/place.stream.server.getStorage";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<S: BosStr> = GetStorage;
    type Response = GetStorageResponse;
}