jacquard-api 0.12.0-beta.2

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

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: sh.tangled.sync.requestCrawl
//
// 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::deps::smol_str::SmolStr;
use jacquard_common::types::string::AtUri;
use jacquard_common::types::value::Data;
use jacquard_common::{BosStr, CowStr, DefaultStr, FromStaticStr};
use jacquard_derive::{IntoStatic, open_union};
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic, Default)]
#[serde(
    rename_all = "camelCase",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct RequestCrawl<S: BosStr = DefaultStr> {
    ///specific repository to ensure crawling
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ensure_repo: Option<AtUri<S>>,
    ///Hostname of the current service (eg, Knot) that is requesting to be crawled.
    pub hostname: 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 RequestCrawlError {
    #[serde(rename = "HostBanned")]
    HostBanned(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other {
        error: SmolStr,
        message: Option<SmolStr>,
    },
}

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

/// Response type for sh.tangled.sync.requestCrawl
pub struct RequestCrawlResponse;
impl jacquard_common::xrpc::XrpcResp for RequestCrawlResponse {
    const NSID: &'static str = "sh.tangled.sync.requestCrawl";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = ();
    type Err = RequestCrawlError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for RequestCrawl<S> {
    const NSID: &'static str = "sh.tangled.sync.requestCrawl";
    const METHOD: jacquard_common::xrpc::XrpcMethod =
        jacquard_common::xrpc::XrpcMethod::Procedure("application/json");
    type Response = RequestCrawlResponse;
}

/// Endpoint type for sh.tangled.sync.requestCrawl
pub struct RequestCrawlRequest;
impl jacquard_common::xrpc::XrpcEndpoint for RequestCrawlRequest {
    const PATH: &'static str = "/xrpc/sh.tangled.sync.requestCrawl";
    const METHOD: jacquard_common::xrpc::XrpcMethod =
        jacquard_common::xrpc::XrpcMethod::Procedure("application/json");
    type Request<S: BosStr> = RequestCrawl<S>;
    type Response = RequestCrawlResponse;
}