jacquard-api 0.12.0-beta.2

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: science.alt.dataset.resolveSchema
//
// 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)]
#[serde(
    rename_all = "camelCase",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct ResolveSchema<S: BosStr = DefaultStr> {
    pub handle: S,
    pub schema_id: S,
    ///(max length: 20)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<S>,
}

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct ResolveSchemaOutput<S: BosStr = DefaultStr> {
    ///CID of the resolved schema record
    pub cid: S,
    ///The full schema record
    pub record: Data<S>,
    ///AT-URI of the resolved schema record
    pub uri: AtUri<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 ResolveSchemaError {
    /// No schema found with the given NSID
    #[serde(rename = "SchemaNotFound")]
    SchemaNotFound(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other {
        error: SmolStr,
        message: Option<SmolStr>,
    },
}

impl core::fmt::Display for ResolveSchemaError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::SchemaNotFound(msg) => {
                write!(f, "SchemaNotFound")?;
                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 science.alt.dataset.resolveSchema
pub struct ResolveSchemaResponse;
impl jacquard_common::xrpc::XrpcResp for ResolveSchemaResponse {
    const NSID: &'static str = "science.alt.dataset.resolveSchema";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = ResolveSchemaOutput<S>;
    type Err = ResolveSchemaError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for ResolveSchema<S> {
    const NSID: &'static str = "science.alt.dataset.resolveSchema";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = ResolveSchemaResponse;
}

/// Endpoint type for science.alt.dataset.resolveSchema
pub struct ResolveSchemaRequest;
impl jacquard_common::xrpc::XrpcEndpoint for ResolveSchemaRequest {
    const PATH: &'static str = "/xrpc/science.alt.dataset.resolveSchema";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<S: BosStr> = ResolveSchema<S>;
    type Response = ResolveSchemaResponse;
}

pub mod resolve_schema_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 Handle;
        type SchemaId;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Handle = Unset;
        type SchemaId = Unset;
    }
    ///State transition - sets the `handle` field to Set
    pub struct SetHandle<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetHandle<St> {}
    impl<St: State> State for SetHandle<St> {
        type Handle = Set<members::handle>;
        type SchemaId = St::SchemaId;
    }
    ///State transition - sets the `schema_id` field to Set
    pub struct SetSchemaId<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetSchemaId<St> {}
    impl<St: State> State for SetSchemaId<St> {
        type Handle = St::Handle;
        type SchemaId = Set<members::schema_id>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `handle` field
        pub struct handle(());
        ///Marker type for the `schema_id` field
        pub struct schema_id(());
    }
}

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

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

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

impl<S: BosStr, St> ResolveSchemaBuilder<S, St>
where
    St: resolve_schema_state::State,
    St::Handle: resolve_schema_state::IsUnset,
{
    /// Set the `handle` field (required)
    pub fn handle(
        mut self,
        value: impl Into<S>,
    ) -> ResolveSchemaBuilder<S, resolve_schema_state::SetHandle<St>> {
        self._fields.0 = Option::Some(value.into());
        ResolveSchemaBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> ResolveSchemaBuilder<S, St>
where
    St: resolve_schema_state::State,
    St::SchemaId: resolve_schema_state::IsUnset,
{
    /// Set the `schemaId` field (required)
    pub fn schema_id(
        mut self,
        value: impl Into<S>,
    ) -> ResolveSchemaBuilder<S, resolve_schema_state::SetSchemaId<St>> {
        self._fields.1 = Option::Some(value.into());
        ResolveSchemaBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St: resolve_schema_state::State> ResolveSchemaBuilder<S, St> {
    /// Set the `version` field (optional)
    pub fn version(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.2 = value.into();
        self
    }
    /// Set the `version` field to an Option value (optional)
    pub fn maybe_version(mut self, value: Option<S>) -> Self {
        self._fields.2 = value;
        self
    }
}

impl<S: BosStr, St> ResolveSchemaBuilder<S, St>
where
    St: resolve_schema_state::State,
    St::Handle: resolve_schema_state::IsSet,
    St::SchemaId: resolve_schema_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> ResolveSchema<S> {
        ResolveSchema {
            handle: self._fields.0.unwrap(),
            schema_id: self._fields.1.unwrap(),
            version: self._fields.2,
        }
    }
}