jacquard-api 0.12.0-beta.1

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: com.whtwnd.blog.getEntryMetadataByName
//
// 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::ident::AtIdentifier;
use jacquard_common::types::string::{AtUri, Cid, Datetime};
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 GetEntryMetadataByName<S: BosStr = DefaultStr> {
    pub author: AtIdentifier<S>,
    pub entry_title: S,
}


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetEntryMetadataByNameOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cid: Option<Cid<S>>,
    pub entry_uri: AtUri<S>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub last_update: Option<Datetime>,
    #[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 GetEntryMetadataByNameError {
    /// If the associated name isn't registered in the author's repo, this error is returned
    #[serde(rename = "NotFound")]
    NotFound(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other { error: SmolStr, message: Option<SmolStr> },
}

impl core::fmt::Display for GetEntryMetadataByNameError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::NotFound(msg) => {
                write!(f, "NotFound")?;
                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 com.whtwnd.blog.getEntryMetadataByName
pub struct GetEntryMetadataByNameResponse;
impl jacquard_common::xrpc::XrpcResp for GetEntryMetadataByNameResponse {
    const NSID: &'static str = "com.whtwnd.blog.getEntryMetadataByName";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = GetEntryMetadataByNameOutput<S>;
    type Err = GetEntryMetadataByNameError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for GetEntryMetadataByName<S> {
    const NSID: &'static str = "com.whtwnd.blog.getEntryMetadataByName";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetEntryMetadataByNameResponse;
}

/// Endpoint type for com.whtwnd.blog.getEntryMetadataByName
pub struct GetEntryMetadataByNameRequest;
impl jacquard_common::xrpc::XrpcEndpoint for GetEntryMetadataByNameRequest {
    const PATH: &'static str = "/xrpc/com.whtwnd.blog.getEntryMetadataByName";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<S: BosStr> = GetEntryMetadataByName<S>;
    type Response = GetEntryMetadataByNameResponse;
}

pub mod get_entry_metadata_by_name_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 EntryTitle;
        type Author;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type EntryTitle = Unset;
        type Author = Unset;
    }
    ///State transition - sets the `entry_title` field to Set
    pub struct SetEntryTitle<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetEntryTitle<St> {}
    impl<St: State> State for SetEntryTitle<St> {
        type EntryTitle = Set<members::entry_title>;
        type Author = St::Author;
    }
    ///State transition - sets the `author` field to Set
    pub struct SetAuthor<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetAuthor<St> {}
    impl<St: State> State for SetAuthor<St> {
        type EntryTitle = St::EntryTitle;
        type Author = Set<members::author>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `entry_title` field
        pub struct entry_title(());
        ///Marker type for the `author` field
        pub struct author(());
    }
}

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

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

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

impl<S: BosStr, St> GetEntryMetadataByNameBuilder<S, St>
where
    St: get_entry_metadata_by_name_state::State,
    St::Author: get_entry_metadata_by_name_state::IsUnset,
{
    /// Set the `author` field (required)
    pub fn author(
        mut self,
        value: impl Into<AtIdentifier<S>>,
    ) -> GetEntryMetadataByNameBuilder<
        S,
        get_entry_metadata_by_name_state::SetAuthor<St>,
    > {
        self._fields.0 = Option::Some(value.into());
        GetEntryMetadataByNameBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> GetEntryMetadataByNameBuilder<S, St>
where
    St: get_entry_metadata_by_name_state::State,
    St::EntryTitle: get_entry_metadata_by_name_state::IsUnset,
{
    /// Set the `entryTitle` field (required)
    pub fn entry_title(
        mut self,
        value: impl Into<S>,
    ) -> GetEntryMetadataByNameBuilder<
        S,
        get_entry_metadata_by_name_state::SetEntryTitle<St>,
    > {
        self._fields.1 = Option::Some(value.into());
        GetEntryMetadataByNameBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> GetEntryMetadataByNameBuilder<S, St>
where
    St: get_entry_metadata_by_name_state::State,
    St::EntryTitle: get_entry_metadata_by_name_state::IsSet,
    St::Author: get_entry_metadata_by_name_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> GetEntryMetadataByName<S> {
        GetEntryMetadataByName {
            author: self._fields.0.unwrap(),
            entry_title: self._fields.1.unwrap(),
        }
    }
}