jacquard-api 0.12.0-beta.1

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: sh.tangled.repo.forkStatus
//
// 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::Did;
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 ForkStatus<S: BosStr = DefaultStr> {
    ///Branch to check status for
    pub branch: S,
    ///DID of the fork owner
    pub did: Did<S>,
    ///Hidden ref to use for comparison
    pub hidden_ref: S,
    ///Name of the forked repository
    pub name: S,
    ///Source repository URL
    pub source: 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 ForkStatusOutput<S: BosStr = DefaultStr> {
    ///Fork status: 0=UpToDate, 1=FastForwardable, 2=Conflict, 3=MissingBranch
    pub status: i64,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/// Response type for sh.tangled.repo.forkStatus
pub struct ForkStatusResponse;
impl jacquard_common::xrpc::XrpcResp for ForkStatusResponse {
    const NSID: &'static str = "sh.tangled.repo.forkStatus";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = ForkStatusOutput<S>;
    type Err = jacquard_common::xrpc::GenericError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for ForkStatus<S> {
    const NSID: &'static str = "sh.tangled.repo.forkStatus";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = ForkStatusResponse;
}

/// Endpoint type for sh.tangled.repo.forkStatus
pub struct ForkStatusRequest;
impl jacquard_common::xrpc::XrpcEndpoint for ForkStatusRequest {
    const PATH: &'static str = "/xrpc/sh.tangled.repo.forkStatus";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Request<S: BosStr> = ForkStatus<S>;
    type Response = ForkStatusResponse;
}

pub mod fork_status_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 Did;
        type Branch;
        type HiddenRef;
        type Source;
        type Name;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Did = Unset;
        type Branch = Unset;
        type HiddenRef = Unset;
        type Source = Unset;
        type Name = Unset;
    }
    ///State transition - sets the `did` field to Set
    pub struct SetDid<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetDid<St> {}
    impl<St: State> State for SetDid<St> {
        type Did = Set<members::did>;
        type Branch = St::Branch;
        type HiddenRef = St::HiddenRef;
        type Source = St::Source;
        type Name = St::Name;
    }
    ///State transition - sets the `branch` field to Set
    pub struct SetBranch<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetBranch<St> {}
    impl<St: State> State for SetBranch<St> {
        type Did = St::Did;
        type Branch = Set<members::branch>;
        type HiddenRef = St::HiddenRef;
        type Source = St::Source;
        type Name = St::Name;
    }
    ///State transition - sets the `hidden_ref` field to Set
    pub struct SetHiddenRef<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetHiddenRef<St> {}
    impl<St: State> State for SetHiddenRef<St> {
        type Did = St::Did;
        type Branch = St::Branch;
        type HiddenRef = Set<members::hidden_ref>;
        type Source = St::Source;
        type Name = St::Name;
    }
    ///State transition - sets the `source` field to Set
    pub struct SetSource<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetSource<St> {}
    impl<St: State> State for SetSource<St> {
        type Did = St::Did;
        type Branch = St::Branch;
        type HiddenRef = St::HiddenRef;
        type Source = Set<members::source>;
        type Name = St::Name;
    }
    ///State transition - sets the `name` field to Set
    pub struct SetName<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetName<St> {}
    impl<St: State> State for SetName<St> {
        type Did = St::Did;
        type Branch = St::Branch;
        type HiddenRef = St::HiddenRef;
        type Source = St::Source;
        type Name = Set<members::name>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `did` field
        pub struct did(());
        ///Marker type for the `branch` field
        pub struct branch(());
        ///Marker type for the `hidden_ref` field
        pub struct hidden_ref(());
        ///Marker type for the `source` field
        pub struct source(());
        ///Marker type for the `name` field
        pub struct name(());
    }
}

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

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

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

impl<S: BosStr, St> ForkStatusBuilder<S, St>
where
    St: fork_status_state::State,
    St::Branch: fork_status_state::IsUnset,
{
    /// Set the `branch` field (required)
    pub fn branch(
        mut self,
        value: impl Into<S>,
    ) -> ForkStatusBuilder<S, fork_status_state::SetBranch<St>> {
        self._fields.0 = Option::Some(value.into());
        ForkStatusBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> ForkStatusBuilder<S, St>
where
    St: fork_status_state::State,
    St::Did: fork_status_state::IsUnset,
{
    /// Set the `did` field (required)
    pub fn did(
        mut self,
        value: impl Into<Did<S>>,
    ) -> ForkStatusBuilder<S, fork_status_state::SetDid<St>> {
        self._fields.1 = Option::Some(value.into());
        ForkStatusBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> ForkStatusBuilder<S, St>
where
    St: fork_status_state::State,
    St::HiddenRef: fork_status_state::IsUnset,
{
    /// Set the `hiddenRef` field (required)
    pub fn hidden_ref(
        mut self,
        value: impl Into<S>,
    ) -> ForkStatusBuilder<S, fork_status_state::SetHiddenRef<St>> {
        self._fields.2 = Option::Some(value.into());
        ForkStatusBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> ForkStatusBuilder<S, St>
where
    St: fork_status_state::State,
    St::Name: fork_status_state::IsUnset,
{
    /// Set the `name` field (required)
    pub fn name(
        mut self,
        value: impl Into<S>,
    ) -> ForkStatusBuilder<S, fork_status_state::SetName<St>> {
        self._fields.3 = Option::Some(value.into());
        ForkStatusBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> ForkStatusBuilder<S, St>
where
    St: fork_status_state::State,
    St::Source: fork_status_state::IsUnset,
{
    /// Set the `source` field (required)
    pub fn source(
        mut self,
        value: impl Into<S>,
    ) -> ForkStatusBuilder<S, fork_status_state::SetSource<St>> {
        self._fields.4 = Option::Some(value.into());
        ForkStatusBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> ForkStatusBuilder<S, St>
where
    St: fork_status_state::State,
    St::Did: fork_status_state::IsSet,
    St::Branch: fork_status_state::IsSet,
    St::HiddenRef: fork_status_state::IsSet,
    St::Source: fork_status_state::IsSet,
    St::Name: fork_status_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> ForkStatus<S> {
        ForkStatus {
            branch: self._fields.0.unwrap(),
            did: self._fields.1.unwrap(),
            hidden_ref: self._fields.2.unwrap(),
            name: self._fields.3.unwrap(),
            source: self._fields.4.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>>,
    ) -> ForkStatus<S> {
        ForkStatus {
            branch: self._fields.0.unwrap(),
            did: self._fields.1.unwrap(),
            hidden_ref: self._fields.2.unwrap(),
            name: self._fields.3.unwrap(),
            source: self._fields.4.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}