jacquard-api 0.12.0

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: ooo.bsky.hds.createRecord
//
// 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::{Nsid, Cid, RecordKey, Rkey, UriValue};
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 CreateRecord<S: BosStr = DefaultStr> {
    pub collection: Nsid<S>,
    pub gate_uri: UriValue<S>,
    pub record: Data<S>,
    pub repo: AtIdentifier<S>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rkey: Option<RecordKey<Rkey<S>>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub validate: Option<bool>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct CreateRecordOutput<S: BosStr = DefaultStr> {
    pub cid: Cid<S>,
    pub uri: UriValue<S>,
    pub validation_status: 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 CreateRecordError {
    #[serde(rename = "AlreadyExists")]
    AlreadyExists(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other { error: SmolStr, message: Option<SmolStr> },
}

impl core::fmt::Display for CreateRecordError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::AlreadyExists(msg) => {
                write!(f, "AlreadyExists")?;
                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 `ooo.bsky.hds.createRecord` procedure.

Implements `jacquard_common::xrpc::XrpcResp`; successful bodies decode as `Self::Output<S>`, which is `CreateRecordOutput<S>` for this endpoint.*/
pub struct CreateRecordResponse;
impl jacquard_common::xrpc::XrpcResp for CreateRecordResponse {
    const NSID: &'static str = "ooo.bsky.hds.createRecord";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = CreateRecordOutput<S>;
    type Err = CreateRecordError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for CreateRecord<S> {
    const NSID: &'static str = "ooo.bsky.hds.createRecord";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = CreateRecordResponse;
}

/** Endpoint marker for the `ooo.bsky.hds.createRecord` procedure.

Path: `/xrpc/ooo.bsky.hds.createRecord`. The request payload type is `CreateRecord<S>`; send that request with `jacquard::Client` or use this marker through lower-level `XrpcEndpoint` APIs.*/
pub struct CreateRecordRequest;
impl jacquard_common::xrpc::XrpcEndpoint for CreateRecordRequest {
    const PATH: &'static str = "/xrpc/ooo.bsky.hds.createRecord";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Request<S: BosStr> = CreateRecord<S>;
    type Response = CreateRecordResponse;
}

pub mod create_record_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 Collection;
        type GateUri;
        type Record;
        type Repo;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Collection = Unset;
        type GateUri = Unset;
        type Record = Unset;
        type Repo = Unset;
    }
    ///State transition - sets the `collection` field to Set
    pub struct SetCollection<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetCollection<St> {}
    impl<St: State> State for SetCollection<St> {
        type Collection = Set<members::collection>;
        type GateUri = St::GateUri;
        type Record = St::Record;
        type Repo = St::Repo;
    }
    ///State transition - sets the `gate_uri` field to Set
    pub struct SetGateUri<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetGateUri<St> {}
    impl<St: State> State for SetGateUri<St> {
        type Collection = St::Collection;
        type GateUri = Set<members::gate_uri>;
        type Record = St::Record;
        type Repo = St::Repo;
    }
    ///State transition - sets the `record` field to Set
    pub struct SetRecord<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetRecord<St> {}
    impl<St: State> State for SetRecord<St> {
        type Collection = St::Collection;
        type GateUri = St::GateUri;
        type Record = Set<members::record>;
        type Repo = St::Repo;
    }
    ///State transition - sets the `repo` field to Set
    pub struct SetRepo<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetRepo<St> {}
    impl<St: State> State for SetRepo<St> {
        type Collection = St::Collection;
        type GateUri = St::GateUri;
        type Record = St::Record;
        type Repo = Set<members::repo>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `collection` field
        pub struct collection(());
        ///Marker type for the `gate_uri` field
        pub struct gate_uri(());
        ///Marker type for the `record` field
        pub struct record(());
        ///Marker type for the `repo` field
        pub struct repo(());
    }
}

/// Builder for constructing an instance of this type.
pub struct CreateRecordBuilder<St: create_record_state::State, S: BosStr = DefaultStr> {
    _state: PhantomData<fn() -> St>,
    _fields: (
        Option<Nsid<S>>,
        Option<UriValue<S>>,
        Option<Data<S>>,
        Option<AtIdentifier<S>>,
        Option<RecordKey<Rkey<S>>>,
        Option<bool>,
    ),
    _type: PhantomData<fn() -> S>,
}

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

impl<S: BosStr> CreateRecord<S> {
    /// Create a new builder for this type
    pub fn builder() -> CreateRecordBuilder<create_record_state::Empty, S> {
        CreateRecordBuilder::builder()
    }
}

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

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

impl<St, S: BosStr> CreateRecordBuilder<St, S>
where
    St: create_record_state::State,
    St::Collection: create_record_state::IsUnset,
{
    /// Set the `collection` field (required)
    pub fn collection(
        mut self,
        value: impl Into<Nsid<S>>,
    ) -> CreateRecordBuilder<create_record_state::SetCollection<St>, S> {
        self._fields.0 = Option::Some(value.into());
        CreateRecordBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> CreateRecordBuilder<St, S>
where
    St: create_record_state::State,
    St::GateUri: create_record_state::IsUnset,
{
    /// Set the `gateUri` field (required)
    pub fn gate_uri(
        mut self,
        value: impl Into<UriValue<S>>,
    ) -> CreateRecordBuilder<create_record_state::SetGateUri<St>, S> {
        self._fields.1 = Option::Some(value.into());
        CreateRecordBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> CreateRecordBuilder<St, S>
where
    St: create_record_state::State,
    St::Record: create_record_state::IsUnset,
{
    /// Set the `record` field (required)
    pub fn record(
        mut self,
        value: impl Into<Data<S>>,
    ) -> CreateRecordBuilder<create_record_state::SetRecord<St>, S> {
        self._fields.2 = Option::Some(value.into());
        CreateRecordBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> CreateRecordBuilder<St, S>
where
    St: create_record_state::State,
    St::Repo: create_record_state::IsUnset,
{
    /// Set the `repo` field (required)
    pub fn repo(
        mut self,
        value: impl Into<AtIdentifier<S>>,
    ) -> CreateRecordBuilder<create_record_state::SetRepo<St>, S> {
        self._fields.3 = Option::Some(value.into());
        CreateRecordBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St: create_record_state::State, S: BosStr> CreateRecordBuilder<St, S> {
    /// Set the `rkey` field (optional)
    pub fn rkey(mut self, value: impl Into<Option<RecordKey<Rkey<S>>>>) -> Self {
        self._fields.4 = value.into();
        self
    }
    /// Set the `rkey` field to an Option value (optional)
    pub fn maybe_rkey(mut self, value: Option<RecordKey<Rkey<S>>>) -> Self {
        self._fields.4 = value;
        self
    }
}

impl<St: create_record_state::State, S: BosStr> CreateRecordBuilder<St, S> {
    /// Set the `validate` field (optional)
    pub fn validate(mut self, value: impl Into<Option<bool>>) -> Self {
        self._fields.5 = value.into();
        self
    }
    /// Set the `validate` field to an Option value (optional)
    pub fn maybe_validate(mut self, value: Option<bool>) -> Self {
        self._fields.5 = value;
        self
    }
}

impl<St, S: BosStr> CreateRecordBuilder<St, S>
where
    St: create_record_state::State,
    St::Collection: create_record_state::IsSet,
    St::GateUri: create_record_state::IsSet,
    St::Record: create_record_state::IsSet,
    St::Repo: create_record_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> CreateRecord<S> {
        CreateRecord {
            collection: self._fields.0.unwrap(),
            gate_uri: self._fields.1.unwrap(),
            record: self._fields.2.unwrap(),
            repo: self._fields.3.unwrap(),
            rkey: self._fields.4,
            validate: self._fields.5,
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(
        self,
        extra_data: BTreeMap<SmolStr, Data<S>>,
    ) -> CreateRecord<S> {
        CreateRecord {
            collection: self._fields.0.unwrap(),
            gate_uri: self._fields.1.unwrap(),
            record: self._fields.2.unwrap(),
            repo: self._fields.3.unwrap(),
            rkey: self._fields.4,
            validate: self._fields.5,
            extra_data: Some(extra_data),
        }
    }
}