jacquard-api 0.12.0

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.stream.beta.getStatus
//
// 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::{CowStr, 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, open_union};
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetStatus<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub did: Option<Did<S>>,
    pub feature: S,
}


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetStatusOutput<S: BosStr = DefaultStr> {
    ///The account this status applies to.
    pub did: Did<S>,
    ///The feature this status applies to (echoes the request).
    pub feature: S,
    ///granted: the account may use the feature. requested: no grant yet, but an access request is on file. none: no grant and no request.
    pub status: GetStatusOutputStatus<S>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/// granted: the account may use the feature. requested: no grant yet, but an access request is on file. none: no grant and no request.

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum GetStatusOutputStatus<S: BosStr = DefaultStr> {
    Granted,
    Requested,
    None,
    Other(S),
}

impl<S: BosStr> GetStatusOutputStatus<S> {
    pub fn as_str(&self) -> &str {
        match self {
            Self::Granted => "granted",
            Self::Requested => "requested",
            Self::None => "none",
            Self::Other(s) => s.as_ref(),
        }
    }
    /// Construct from a string-like value, matching known values.
    pub fn from_value(s: S) -> Self {
        match s.as_ref() {
            "granted" => Self::Granted,
            "requested" => Self::Requested,
            "none" => Self::None,
            _ => Self::Other(s),
        }
    }
}

impl<S: BosStr> core::fmt::Display for GetStatusOutputStatus<S> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "{}", self.as_str())
    }
}

impl<S: BosStr> AsRef<str> for GetStatusOutputStatus<S> {
    fn as_ref(&self) -> &str {
        self.as_str()
    }
}

impl<S: BosStr> Serialize for GetStatusOutputStatus<S> {
    fn serialize<Ser>(&self, serializer: Ser) -> Result<Ser::Ok, Ser::Error>
    where
        Ser: serde::Serializer,
    {
        serializer.serialize_str(self.as_str())
    }
}

impl<'de, S: Deserialize<'de> + BosStr> Deserialize<'de> for GetStatusOutputStatus<S> {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let s = S::deserialize(deserializer)?;
        Ok(Self::from_value(s))
    }
}

impl<S: BosStr + Default> Default for GetStatusOutputStatus<S> {
    fn default() -> Self {
        Self::Other(Default::default())
    }
}

impl<S: BosStr> jacquard_common::IntoStatic for GetStatusOutputStatus<S>
where
    S: BosStr + jacquard_common::IntoStatic,
    S::Output: BosStr,
{
    type Output = GetStatusOutputStatus<S::Output>;
    fn into_static(self) -> Self::Output {
        match self {
            GetStatusOutputStatus::Granted => GetStatusOutputStatus::Granted,
            GetStatusOutputStatus::Requested => GetStatusOutputStatus::Requested,
            GetStatusOutputStatus::None => GetStatusOutputStatus::None,
            GetStatusOutputStatus::Other(v) => {
                GetStatusOutputStatus::Other(v.into_static())
            }
        }
    }
}


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

#[serde(tag = "error", content = "message")]
pub enum GetStatusError {
    /// No did supplied and the request was not authenticated, so there is no account to check.
    #[serde(rename = "DidRequired")]
    DidRequired(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other { error: SmolStr, message: Option<SmolStr> },
}

impl core::fmt::Display for GetStatusError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::DidRequired(msg) => {
                write!(f, "DidRequired")?;
                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 marker for the `place.stream.beta.getStatus` query.

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

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for GetStatus<S> {
    const NSID: &'static str = "place.stream.beta.getStatus";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetStatusResponse;
}

/** Endpoint marker for the `place.stream.beta.getStatus` query.

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

pub mod get_status_state {

    pub use crate::builder_types::{Set, Unset, IsSet, IsUnset};
    #[allow(unused)]
    use ::core::marker::PhantomData;
    mod sealed {
        pub trait Sealed {}
    }
    /// State trait tracking which required fields have been set
    pub trait State: sealed::Sealed {
        type Feature;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Feature = Unset;
    }
    ///State transition - sets the `feature` field to Set
    pub struct SetFeature<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetFeature<St> {}
    impl<St: State> State for SetFeature<St> {
        type Feature = Set<members::feature>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `feature` field
        pub struct feature(());
    }
}

/// Builder for constructing an instance of this type.
pub struct GetStatusBuilder<St: get_status_state::State, S: BosStr = DefaultStr> {
    _state: PhantomData<fn() -> St>,
    _fields: (Option<Did<S>>, Option<S>),
    _type: PhantomData<fn() -> S>,
}

impl GetStatus<DefaultStr> {
    /// Create a new builder for this type, using the default string type (DefaultStr = SmolStr) if needed
    pub fn new() -> GetStatusBuilder<get_status_state::Empty, DefaultStr> {
        GetStatusBuilder::new()
    }
}

impl<S: BosStr> GetStatus<S> {
    /// Create a new builder for this type
    pub fn builder() -> GetStatusBuilder<get_status_state::Empty, S> {
        GetStatusBuilder::builder()
    }
}

impl GetStatusBuilder<get_status_state::Empty, DefaultStr> {
    /// Create a new builder with all fields unset, using the default string type, if needed
    pub fn new() -> Self {
        GetStatusBuilder {
            _state: PhantomData,
            _fields: (None, None),
            _type: PhantomData,
        }
    }
}

impl<S: BosStr> GetStatusBuilder<get_status_state::Empty, S> {
    /// Create a new builder with all fields unset
    pub fn builder() -> Self {
        GetStatusBuilder {
            _state: PhantomData,
            _fields: (None, None),
            _type: PhantomData,
        }
    }
}

impl<St: get_status_state::State, S: BosStr> GetStatusBuilder<St, S> {
    /// Set the `did` field (optional)
    pub fn did(mut self, value: impl Into<Option<Did<S>>>) -> Self {
        self._fields.0 = value.into();
        self
    }
    /// Set the `did` field to an Option value (optional)
    pub fn maybe_did(mut self, value: Option<Did<S>>) -> Self {
        self._fields.0 = value;
        self
    }
}

impl<St, S: BosStr> GetStatusBuilder<St, S>
where
    St: get_status_state::State,
    St::Feature: get_status_state::IsUnset,
{
    /// Set the `feature` field (required)
    pub fn feature(
        mut self,
        value: impl Into<S>,
    ) -> GetStatusBuilder<get_status_state::SetFeature<St>, S> {
        self._fields.1 = Option::Some(value.into());
        GetStatusBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> GetStatusBuilder<St, S>
where
    St: get_status_state::State,
    St::Feature: get_status_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> GetStatus<S> {
        GetStatus {
            did: self._fields.0,
            feature: self._fields.1.unwrap(),
        }
    }
}