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

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

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