proto_blue_api/generated/com/atproto/admin/
getInviteCodes.rs

1// Generated by atproto-codegen. Do not edit.
2//! Lexicon: com.atproto.admin.getInviteCodes
3
4use serde::{Deserialize, Serialize};
5
6/// Get an admin view of invite codes.
7/// XRPC Query: com.atproto.admin.getInviteCodes
8#[derive(Debug, Clone, Serialize, Deserialize)]
9#[serde(rename_all = "camelCase")]
10pub struct Params {
11    #[serde(skip_serializing_if = "Option::is_none")]
12    pub cursor: Option<String>,
13    #[serde(skip_serializing_if = "Option::is_none")]
14    pub limit: Option<i64>,
15    #[serde(skip_serializing_if = "Option::is_none")]
16    pub sort: Option<String>,
17}
18
19#[derive(Debug, Clone, Serialize, Deserialize)]
20#[serde(rename_all = "camelCase")]
21pub struct Output {
22    pub codes: Vec<crate::com::atproto::server::defs::InviteCode>,
23    #[serde(skip_serializing_if = "Option::is_none")]
24    pub cursor: Option<String>,
25}
26
27/// Errors a `call()` on this method can return.
28#[derive(Debug, thiserror::Error)]
29pub enum CallError {
30    #[error("{0}")]
31    Xrpc(proto_blue_xrpc::XrpcError),
32    #[error(transparent)]
33    Transport(#[from] proto_blue_xrpc::Error),
34    #[error(transparent)]
35    Json(#[from] serde_json::Error),
36}
37
38fn map_xrpc_error(err: proto_blue_xrpc::XrpcError) -> CallError {
39    CallError::Xrpc(err)
40}
41
42fn to_query_params(p: &Params) -> proto_blue_xrpc::QueryParams {
43    let mut qp = proto_blue_xrpc::QueryParams::new();
44    if let Some(v) = &p.cursor {
45        qp.insert(
46            "cursor".to_string(),
47            proto_blue_xrpc::QueryValue::String(v.clone()),
48        );
49    }
50    if let Some(v) = &p.limit {
51        qp.insert(
52            "limit".to_string(),
53            proto_blue_xrpc::QueryValue::Integer(*v),
54        );
55    }
56    if let Some(v) = &p.sort {
57        qp.insert(
58            "sort".to_string(),
59            proto_blue_xrpc::QueryValue::String(v.clone()),
60        );
61    }
62    qp
63}
64
65/// Execute the query.
66pub async fn call(
67    client: &proto_blue_xrpc::XrpcClient,
68    params: Option<&Params>,
69    opts: Option<&proto_blue_xrpc::CallOptions>,
70) -> Result<Output, CallError> {
71    let qp = params.map(to_query_params);
72    let response = match client
73        .query("com.atproto.admin.getInviteCodes", qp.as_ref(), opts)
74        .await
75    {
76        Ok(r) => r,
77        Err(proto_blue_xrpc::Error::Xrpc(x)) => return Err(map_xrpc_error(x)),
78        Err(e) => return Err(CallError::Transport(e)),
79    };
80    Ok(serde_json::from_value(response.data)?)
81}
82
83/// Register a typed handler for this method on an [`proto_blue_xrpc::XrpcServer`].
84#[cfg(feature = "server")]
85pub fn register<F, Fut>(
86    server: proto_blue_xrpc::XrpcServer,
87    handler: F,
88) -> proto_blue_xrpc::XrpcServer
89where
90    F: Fn(proto_blue_xrpc::HandlerContext, Option<Params>) -> Fut + Send + Sync + 'static,
91    Fut: std::future::Future<Output = Result<Output, proto_blue_xrpc::XrpcServerError>>
92        + Send
93        + 'static,
94{
95    let handler = std::sync::Arc::new(handler);
96    server.query("com.atproto.admin.getInviteCodes", move |ctx| {
97        let handler = handler.clone();
98        async move {
99            let params = params_from_ctx(&ctx);
100            let out = handler(ctx, params).await?;
101            let value = serde_json::to_value(&out).map_err(|e| {
102                proto_blue_xrpc::XrpcServerError::new(
103                    proto_blue_xrpc::ResponseType::InternalServerError,
104                    format!("output serialize: {e}"),
105                )
106            })?;
107            Ok::<_, proto_blue_xrpc::XrpcServerError>(value)
108        }
109    })
110}
111
112#[cfg(feature = "server")]
113fn params_from_ctx(ctx: &proto_blue_xrpc::HandlerContext) -> Option<Params> {
114    // Always construct a `Params` — required fields are
115    // validated upstream by the lexicon validator when enabled;
116    // missing values surface as runtime errors from the handler.
117    Some(Params {
118        cursor: ctx.params.get("cursor").cloned(),
119        limit: ctx.params.get("limit").and_then(|v| v.parse::<i64>().ok()),
120        sort: ctx.params.get("sort").cloned(),
121    })
122}
proto_blue_api/generated/com/atproto/admin/getInviteCodes.rs

proto_blue_api/generated/com/atproto/admin/
getInviteCodes.rs
