jacquard-api 0.12.0

// @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, BosStr, DefaultStr, FromStaticStr};
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::string::AtUri;
use jacquard_common::types::value::Data;
use jacquard_derive::IntoStatic;
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct HiddenRef<S: BosStr = DefaultStr> {
    ///Fork reference name
    pub fork_ref: S,
    ///Remote reference name
    pub remote_ref: S,
    ///AT-URI of the repository
    pub repo: 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, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct HiddenRefOutput<S: BosStr = DefaultStr> {
    ///Error message if creation failed
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<S>,
    ///The created hidden ref name
    #[serde(skip_serializing_if = "Option::is_none")]
    pub r#ref: Option<S>,
    ///Whether the hidden ref was created successfully
    pub success: bool,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/** Response marker for the `sh.tangled.repo.hiddenRef` procedure.

Implements `jacquard_common::xrpc::XrpcResp`; successful bodies decode as `Self::Output<S>`, which is `HiddenRefOutput<S>` for this endpoint.*/
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<S: BosStr> = HiddenRefOutput<S>;
    type Err = jacquard_common::xrpc::GenericError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for HiddenRef<S> {
    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 marker for the `sh.tangled.repo.hiddenRef` procedure.

Path: `/xrpc/sh.tangled.repo.hiddenRef`. The request payload type is `HiddenRef<S>`; send that request with `jacquard::Client` or use this marker through lower-level `XrpcEndpoint` APIs.*/
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<S: BosStr> = HiddenRef<S>;
    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<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetForkRef<St> {}
    impl<St: State> State for SetForkRef<St> {
        type ForkRef = Set<members::fork_ref>;
        type RemoteRef = St::RemoteRef;
        type Repo = St::Repo;
    }
    ///State transition - sets the `remote_ref` field to Set
    pub struct SetRemoteRef<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetRemoteRef<St> {}
    impl<St: State> State for SetRemoteRef<St> {
        type ForkRef = St::ForkRef;
        type RemoteRef = Set<members::remote_ref>;
        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 ForkRef = St::ForkRef;
        type RemoteRef = St::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<St: hidden_ref_state::State, S: BosStr = DefaultStr> {
    _state: PhantomData<fn() -> St>,
    _fields: (Option<S>, Option<S>, Option<AtUri<S>>),
    _type: PhantomData<fn() -> S>,
}

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

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

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

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

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

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

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

impl<St, S: BosStr> HiddenRefBuilder<St, S>
where
    St: hidden_ref_state::State,
    St::ForkRef: hidden_ref_state::IsSet,
    St::RemoteRef: hidden_ref_state::IsSet,
    St::Repo: hidden_ref_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> HiddenRef<S> {
        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<SmolStr, Data<S>>,
    ) -> HiddenRef<S> {
        HiddenRef {
            fork_ref: self._fields.0.unwrap(),
            remote_ref: self._fields.1.unwrap(),
            repo: self._fields.2.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}