jacquard-api 0.12.0-beta.2

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: sh.tangled.git.temp.getEntity
//
// 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;

use crate::sh_tangled::git::temp::Blob;
#[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 GetEntity<S: BosStr = DefaultStr> {
    pub path: S,
    ///Defaults to `"HEAD"`.
    #[serde(default = "_default_ref")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub r#ref: Option<S>,
    pub repo: AtUri<S>,
}

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct GetEntityOutput<S: BosStr = DefaultStr> {
    #[serde(flatten)]
    pub value: Blob<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 GetEntityError {
    /// Repository not found or access denied
    #[serde(rename = "RepoNotFound")]
    RepoNotFound(Option<SmolStr>),
    /// Blob not found
    #[serde(rename = "BlobNotFound")]
    BlobNotFound(Option<SmolStr>),
    /// Invalid request parameters
    #[serde(rename = "InvalidRequest")]
    InvalidRequest(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other {
        error: SmolStr,
        message: Option<SmolStr>,
    },
}

impl core::fmt::Display for GetEntityError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::RepoNotFound(msg) => {
                write!(f, "RepoNotFound")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::BlobNotFound(msg) => {
                write!(f, "BlobNotFound")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::InvalidRequest(msg) => {
                write!(f, "InvalidRequest")?;
                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 sh.tangled.git.temp.getEntity
pub struct GetEntityResponse;
impl jacquard_common::xrpc::XrpcResp for GetEntityResponse {
    const NSID: &'static str = "sh.tangled.git.temp.getEntity";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = GetEntityOutput<S>;
    type Err = GetEntityError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for GetEntity<S> {
    const NSID: &'static str = "sh.tangled.git.temp.getEntity";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetEntityResponse;
}

/// Endpoint type for sh.tangled.git.temp.getEntity
pub struct GetEntityRequest;
impl jacquard_common::xrpc::XrpcEndpoint for GetEntityRequest {
    const PATH: &'static str = "/xrpc/sh.tangled.git.temp.getEntity";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<S: BosStr> = GetEntity<S>;
    type Response = GetEntityResponse;
}

fn _default_ref<S: jacquard_common::FromStaticStr>() -> Option<S> {
    Some(S::from_static("HEAD"))
}

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

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

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

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

impl<S: BosStr, St> GetEntityBuilder<S, St>
where
    St: get_entity_state::State,
    St::Path: get_entity_state::IsUnset,
{
    /// Set the `path` field (required)
    pub fn path(
        mut self,
        value: impl Into<S>,
    ) -> GetEntityBuilder<S, get_entity_state::SetPath<St>> {
        self._fields.0 = Option::Some(value.into());
        GetEntityBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St: get_entity_state::State> GetEntityBuilder<S, St> {
    /// Set the `ref` field (optional)
    pub fn r#ref(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.1 = value.into();
        self
    }
    /// Set the `ref` field to an Option value (optional)
    pub fn maybe_ref(mut self, value: Option<S>) -> Self {
        self._fields.1 = value;
        self
    }
}

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

impl<S: BosStr, St> GetEntityBuilder<S, St>
where
    St: get_entity_state::State,
    St::Path: get_entity_state::IsSet,
    St::Repo: get_entity_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> GetEntity<S> {
        GetEntity {
            path: self._fields.0.unwrap(),
            r#ref: self._fields.1,
            repo: self._fields.2.unwrap(),
        }
    }
}