jacquard-api 0.12.0-beta.2

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.stream.branding.getBlob
//
// 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::bytes::Bytes;
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::string::Did;
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)]
#[serde(
    rename_all = "camelCase",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct GetBlob<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub broadcaster: Option<Did<S>>,
    pub key: S,
}

/// Raw blob data with appropriate content-type

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct GetBlobOutput {
    pub body: Bytes,
}

#[derive(
    Serialize, Deserialize, Debug, Clone, PartialEq, Eq, thiserror::Error, miette::Diagnostic,
)]
#[serde(tag = "error", content = "message")]
pub enum GetBlobError {
    /// The requested branding asset does not exist
    #[serde(rename = "BrandingNotFound")]
    BrandingNotFound(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other {
        error: SmolStr,
        message: Option<SmolStr>,
    },
}

impl core::fmt::Display for GetBlobError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::BrandingNotFound(msg) => {
                write!(f, "BrandingNotFound")?;
                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 place.stream.branding.getBlob
pub struct GetBlobResponse;
impl jacquard_common::xrpc::XrpcResp for GetBlobResponse {
    const NSID: &'static str = "place.stream.branding.getBlob";
    const ENCODING: &'static str = "*/*";
    type Output<S: BosStr> = GetBlobOutput;
    type Err = GetBlobError;
    fn encode_output<S: BosStr>(
        output: &Self::Output<S>,
    ) -> Result<Vec<u8>, jacquard_common::xrpc::EncodeError>
    where
        Self::Output<S>: Serialize,
    {
        Ok(output.body.to_vec())
    }
    fn decode_output<'de, S>(
        body: &'de [u8],
    ) -> Result<Self::Output<S>, jacquard_common::error::DecodeError>
    where
        S: BosStr + Deserialize<'de>,
        Self::Output<S>: Deserialize<'de>,
    {
        Ok(GetBlobOutput {
            body: jacquard_common::deps::bytes::Bytes::copy_from_slice(body),
        })
    }
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for GetBlob<S> {
    const NSID: &'static str = "place.stream.branding.getBlob";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetBlobResponse;
}

/// Endpoint type for place.stream.branding.getBlob
pub struct GetBlobRequest;
impl jacquard_common::xrpc::XrpcEndpoint for GetBlobRequest {
    const PATH: &'static str = "/xrpc/place.stream.branding.getBlob";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<S: BosStr> = GetBlob<S>;
    type Response = GetBlobResponse;
}

pub mod get_blob_state {

    pub use crate::builder_types::{IsSet, IsUnset, Set, Unset};
    #[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 Key;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Key = Unset;
    }
    ///State transition - sets the `key` field to Set
    pub struct SetKey<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetKey<St> {}
    impl<St: State> State for SetKey<St> {
        type Key = Set<members::key>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `key` field
        pub struct key(());
    }
}

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

impl<S: BosStr> GetBlob<S> {
    /// Create a new builder for this type.
    pub fn new() -> GetBlobBuilder<S, get_blob_state::Empty> {
        GetBlobBuilder::new()
    }
}

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

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

impl<S: BosStr, St> GetBlobBuilder<S, St>
where
    St: get_blob_state::State,
    St::Key: get_blob_state::IsUnset,
{
    /// Set the `key` field (required)
    pub fn key(mut self, value: impl Into<S>) -> GetBlobBuilder<S, get_blob_state::SetKey<St>> {
        self._fields.1 = Option::Some(value.into());
        GetBlobBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> GetBlobBuilder<S, St>
where
    St: get_blob_state::State,
    St::Key: get_blob_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> GetBlob<S> {
        GetBlob {
            broadcaster: self._fields.0,
            key: self._fields.1.unwrap(),
        }
    }
}