jacquard-api 0.12.0

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: io.atcr.hold.getPartUploadUrl
//
// 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::UriValue;
use jacquard_common::types::value::Data;
use jacquard_derive::{IntoStatic, open_union};
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetPartUploadUrl<S: BosStr = DefaultStr> {
    ///Part sequence number (1-indexed)
    pub part_number: i64,
    ///Upload session ID from initiateUpload
    pub upload_id: 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 GetPartUploadUrlOutput<S: BosStr = DefaultStr> {
    ///Additional headers required for the request (e.g., content-type)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub headers: Option<Data<S>>,
    ///HTTP method to use (usually PUT)  Defaults to `"PUT"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default = "_default_get_part_upload_url_output_method")]
    pub method: Option<S>,
    ///URL to PUT the part data to
    pub url: UriValue<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 GetPartUploadUrlError {
    #[serde(rename = "InvalidUploadId")]
    InvalidUploadId(Option<SmolStr>),
    #[serde(rename = "InvalidPartNumber")]
    InvalidPartNumber(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other { error: SmolStr, message: Option<SmolStr> },
}

impl core::fmt::Display for GetPartUploadUrlError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::InvalidUploadId(msg) => {
                write!(f, "InvalidUploadId")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::InvalidPartNumber(msg) => {
                write!(f, "InvalidPartNumber")?;
                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 marker for the `io.atcr.hold.getPartUploadUrl` procedure.

Implements `jacquard_common::xrpc::XrpcResp`; successful bodies decode as `Self::Output<S>`, which is `GetPartUploadUrlOutput<S>` for this endpoint.*/
pub struct GetPartUploadUrlResponse;
impl jacquard_common::xrpc::XrpcResp for GetPartUploadUrlResponse {
    const NSID: &'static str = "io.atcr.hold.getPartUploadUrl";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = GetPartUploadUrlOutput<S>;
    type Err = GetPartUploadUrlError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for GetPartUploadUrl<S> {
    const NSID: &'static str = "io.atcr.hold.getPartUploadUrl";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = GetPartUploadUrlResponse;
}

/** Endpoint marker for the `io.atcr.hold.getPartUploadUrl` procedure.

Path: `/xrpc/io.atcr.hold.getPartUploadUrl`. The request payload type is `GetPartUploadUrl<S>`; send that request with `jacquard::Client` or use this marker through lower-level `XrpcEndpoint` APIs.*/
pub struct GetPartUploadUrlRequest;
impl jacquard_common::xrpc::XrpcEndpoint for GetPartUploadUrlRequest {
    const PATH: &'static str = "/xrpc/io.atcr.hold.getPartUploadUrl";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Request<S: BosStr> = GetPartUploadUrl<S>;
    type Response = GetPartUploadUrlResponse;
}

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

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

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

impl<S: BosStr> GetPartUploadUrl<S> {
    /// Create a new builder for this type
    pub fn builder() -> GetPartUploadUrlBuilder<get_part_upload_url_state::Empty, S> {
        GetPartUploadUrlBuilder::builder()
    }
}

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

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

impl<St, S: BosStr> GetPartUploadUrlBuilder<St, S>
where
    St: get_part_upload_url_state::State,
    St::PartNumber: get_part_upload_url_state::IsUnset,
{
    /// Set the `partNumber` field (required)
    pub fn part_number(
        mut self,
        value: impl Into<i64>,
    ) -> GetPartUploadUrlBuilder<get_part_upload_url_state::SetPartNumber<St>, S> {
        self._fields.0 = Option::Some(value.into());
        GetPartUploadUrlBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> GetPartUploadUrlBuilder<St, S>
where
    St: get_part_upload_url_state::State,
    St::UploadId: get_part_upload_url_state::IsUnset,
{
    /// Set the `uploadId` field (required)
    pub fn upload_id(
        mut self,
        value: impl Into<S>,
    ) -> GetPartUploadUrlBuilder<get_part_upload_url_state::SetUploadId<St>, S> {
        self._fields.1 = Option::Some(value.into());
        GetPartUploadUrlBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> GetPartUploadUrlBuilder<St, S>
where
    St: get_part_upload_url_state::State,
    St::PartNumber: get_part_upload_url_state::IsSet,
    St::UploadId: get_part_upload_url_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> GetPartUploadUrl<S> {
        GetPartUploadUrl {
            part_number: self._fields.0.unwrap(),
            upload_id: self._fields.1.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>>,
    ) -> GetPartUploadUrl<S> {
        GetPartUploadUrl {
            part_number: self._fields.0.unwrap(),
            upload_id: self._fields.1.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn _default_get_part_upload_url_output_method<S: FromStaticStr>() -> ::core::option::Option<
    S,
> {
    Some(S::from_static("PUT"))
}