foundation_deployment_docker 0.1.3

//! Auto-generated API module for docker load.
//!
//! Generated by `cargo run --bin ewe_platform gen_api`.
//! DO NOT EDIT MANUALLY.
//!
//! Feature flag: `docker_load `

#![cfg(feature = "docker_load")]
#![allow(clippy::too_many_arguments, clippy::type_complexity)]
#![allow(
    clippy::missing_errors_doc,
    clippy::doc_markdown,
    clippy::useless_format
)]
#![allow(unused_imports)]

use foundation_macros::JsonHash;
use foundation_netio::shared::client::http_client::HttpClient;
use foundation_netio::{DynNetClient, PreparedRequestBuilder};
use serde::{Deserialize, Serialize};

// Import shared types used by this module
use super::shared::BuildInfo;
use super::shared::ErrorDetail;
use super::shared::ImageID;
use super::shared::ProgressDetail;

use super::shared::ApiResponse;

// =============================================================================
// TYPE DECLARATIONS
// =============================================================================

// =============================================================================
// ARGS TYPES (per-endpoint)
// =============================================================================

/// Arguments for [`ImageLoad_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct ImageLoadArgs {
    /// Query parameter: `quiet`.
    pub quiet: Option<String>,
    /// Query parameter: `platform` (one per value).
    pub platform: Vec<String>,
}

// =============================================================================
// CLIENT FUNCTIONS (per-endpoint)
// =============================================================================

// -----------------------------------------------------------------------------
// POST /images/load
// -----------------------------------------------------------------------------

/// POST /images/load.
///
/// Takes a client and args, builds the request, optionally applies
/// modifications, then sends it via `send_async().await`.
///
/// # Arguments
///
/// * `client` - HTTP client for making the request: a `DynNetClient`, or an `ApiClient` carrying the `BodyLimits` the response is read under
/// * `args` - Request arguments (path params, query params, body)
/// * `body` - Request body, sent as-is as `application/x-tar` (`None` sends none)
/// * `builder_mod` - Optional closure to modify the request builder (e.g., add headers)
///
/// # Response body
///
/// Returned unread, as a stream of `BuildInfo`, one per line: read it with `.next().await`.
/// The status is checked before the body is touched.
///
/// # Example
///
/// ```ignore
/// let response = image_load_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn image_load_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &ImageLoadArgs,
    base_url: &str,
    body: Option<foundation_netio::shared::http::SendSafeBody>,
    builder_mod: Option<F>,
) -> Result<ApiResponse<super::shared::JsonLinesStream<BuildInfo>>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/images/load",);
    let endpoint_url = format!("{}{}", base_url, path);

    let mut builder = PreparedRequestBuilder::post(&endpoint_url)
        .map_err(|e| super::shared::ApiError::RequestBuildFailed(e.to_string()))?;

    builder = builder.query("quiet", args.quiet.as_deref());
    for value in &args.platform {
        builder = builder.query("platform", Some(value.as_str()));
    }

    if let Some(body) = body {
        builder = super::shared::with_raw_body(builder, "application/x-tar", body);
    }

    if let Some(f) = builder_mod {
        f(&mut builder);
    }

    super::shared::send_json_lines(client.into(), builder.build()).await
}