jacquard-api 0.11.0

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: sh.tangled.repo.hiddenRef
//
// 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;
use jacquard_common::types::string::AtUri;
use jacquard_derive::{IntoStatic, lexicon};
use serde::{Serialize, Deserialize};

#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct HiddenRef<'a> {
    ///Fork reference name
    #[serde(borrow)]
    pub fork_ref: CowStr<'a>,
    ///Remote reference name
    #[serde(borrow)]
    pub remote_ref: CowStr<'a>,
    ///AT-URI of the repository
    #[serde(borrow)]
    pub repo: AtUri<'a>,
}


#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct HiddenRefOutput<'a> {
    ///Error message if creation failed
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub error: Option<CowStr<'a>>,
    ///The created hidden ref name
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub r#ref: Option<CowStr<'a>>,
    ///Whether the hidden ref was created successfully
    pub success: bool,
}

/// Response type for sh.tangled.repo.hiddenRef
pub struct HiddenRefResponse;
impl jacquard_common::xrpc::XrpcResp for HiddenRefResponse {
    const NSID: &'static str = "sh.tangled.repo.hiddenRef";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = HiddenRefOutput<'de>;
    type Err<'de> = jacquard_common::xrpc::GenericError<'de>;
}

impl<'a> jacquard_common::xrpc::XrpcRequest for HiddenRef<'a> {
    const NSID: &'static str = "sh.tangled.repo.hiddenRef";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = HiddenRefResponse;
}

/// Endpoint type for sh.tangled.repo.hiddenRef
pub struct HiddenRefRequest;
impl jacquard_common::xrpc::XrpcEndpoint for HiddenRefRequest {
    const PATH: &'static str = "/xrpc/sh.tangled.repo.hiddenRef";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Request<'de> = HiddenRef<'de>;
    type Response = HiddenRefResponse;
}

pub mod hidden_ref_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 ForkRef;
        type RemoteRef;
        type Repo;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type ForkRef = Unset;
        type RemoteRef = Unset;
        type Repo = Unset;
    }
    ///State transition - sets the `fork_ref` field to Set
    pub struct SetForkRef<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetForkRef<S> {}
    impl<S: State> State for SetForkRef<S> {
        type ForkRef = Set<members::fork_ref>;
        type RemoteRef = S::RemoteRef;
        type Repo = S::Repo;
    }
    ///State transition - sets the `remote_ref` field to Set
    pub struct SetRemoteRef<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetRemoteRef<S> {}
    impl<S: State> State for SetRemoteRef<S> {
        type ForkRef = S::ForkRef;
        type RemoteRef = Set<members::remote_ref>;
        type Repo = S::Repo;
    }
    ///State transition - sets the `repo` field to Set
    pub struct SetRepo<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetRepo<S> {}
    impl<S: State> State for SetRepo<S> {
        type ForkRef = S::ForkRef;
        type RemoteRef = S::RemoteRef;
        type Repo = Set<members::repo>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `fork_ref` field
        pub struct fork_ref(());
        ///Marker type for the `remote_ref` field
        pub struct remote_ref(());
        ///Marker type for the `repo` field
        pub struct repo(());
    }
}

/// Builder for constructing an instance of this type
pub struct HiddenRefBuilder<'a, S: hidden_ref_state::State> {
    _state: PhantomData<fn() -> S>,
    _fields: (Option<CowStr<'a>>, Option<CowStr<'a>>, Option<AtUri<'a>>),
    _lifetime: PhantomData<&'a ()>,
}

impl<'a> HiddenRef<'a> {
    /// Create a new builder for this type
    pub fn new() -> HiddenRefBuilder<'a, hidden_ref_state::Empty> {
        HiddenRefBuilder::new()
    }
}

impl<'a> HiddenRefBuilder<'a, hidden_ref_state::Empty> {
    /// Create a new builder with all fields unset
    pub fn new() -> Self {
        HiddenRefBuilder {
            _state: PhantomData,
            _fields: (None, None, None),
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> HiddenRefBuilder<'a, S>
where
    S: hidden_ref_state::State,
    S::ForkRef: hidden_ref_state::IsUnset,
{
    /// Set the `forkRef` field (required)
    pub fn fork_ref(
        mut self,
        value: impl Into<CowStr<'a>>,
    ) -> HiddenRefBuilder<'a, hidden_ref_state::SetForkRef<S>> {
        self._fields.0 = Option::Some(value.into());
        HiddenRefBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> HiddenRefBuilder<'a, S>
where
    S: hidden_ref_state::State,
    S::RemoteRef: hidden_ref_state::IsUnset,
{
    /// Set the `remoteRef` field (required)
    pub fn remote_ref(
        mut self,
        value: impl Into<CowStr<'a>>,
    ) -> HiddenRefBuilder<'a, hidden_ref_state::SetRemoteRef<S>> {
        self._fields.1 = Option::Some(value.into());
        HiddenRefBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

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

impl<'a, S> HiddenRefBuilder<'a, S>
where
    S: hidden_ref_state::State,
    S::ForkRef: hidden_ref_state::IsSet,
    S::RemoteRef: hidden_ref_state::IsSet,
    S::Repo: hidden_ref_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> HiddenRef<'a> {
        HiddenRef {
            fork_ref: self._fields.0.unwrap(),
            remote_ref: self._fields.1.unwrap(),
            repo: self._fields.2.unwrap(),
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data
    pub fn build_with_data(
        self,
        extra_data: BTreeMap<
            jacquard_common::deps::smol_str::SmolStr,
            jacquard_common::types::value::Data<'a>,
        >,
    ) -> HiddenRef<'a> {
        HiddenRef {
            fork_ref: self._fields.0.unwrap(),
            remote_ref: self._fields.1.unwrap(),
            repo: self._fields.2.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}