foundation_deployment_docker 0.1.0

Docker Engine API v1.53 client over DynNetClient + valtron (bollard-free)
Documentation
//! Auto-generated API module for docker networks.
//!
//! Generated by `cargo run --bin ewe_platform gen_api`.
//! DO NOT EDIT MANUALLY.
//!
//! Feature flag: `docker_networks `

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

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

use super::shared::ApiResponse;

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

/// `ConfigReference` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct ConfigReference {
    /// Network property.
    #[serde(rename = "Network")]
    pub network: Option<String>,
}

/// `PeerInfo` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct PeerInfo {
    /// IP property.
    #[serde(rename = "IP")]
    pub ip: Option<String>,
    /// Name property.
    #[serde(rename = "Name")]
    pub name: Option<String>,
}

/// `IPAMConfig` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct IPAMConfig {
    /// AuxiliaryAddresses property.
    #[serde(rename = "AuxiliaryAddresses")]
    pub auxiliary_addresses: Option<serde_json::Value>,
    /// Gateway property.
    #[serde(rename = "Gateway")]
    pub gateway: Option<String>,
    /// IPRange property.
    #[serde(rename = "IPRange")]
    pub ip_range: Option<String>,
    /// Subnet property.
    #[serde(rename = "Subnet")]
    pub subnet: Option<String>,
}

/// `NetworkInspect` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct NetworkInspect {
}

/// `Network` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct Network {
    /// Attachable property.
    #[serde(rename = "Attachable")]
    pub attachable: Option<bool>,
    /// ConfigFrom property.
    #[serde(rename = "ConfigFrom")]
    pub config_from: Option<ConfigReference>,
    /// ConfigOnly property.
    #[serde(rename = "ConfigOnly")]
    pub config_only: Option<bool>,
    /// Created property.
    #[serde(rename = "Created")]
    pub created: Option<String>,
    /// Driver property.
    #[serde(rename = "Driver")]
    pub driver: Option<String>,
    /// EnableIPv4 property.
    #[serde(rename = "EnableIPv4")]
    pub enable_i_pv4: Option<bool>,
    /// EnableIPv6 property.
    #[serde(rename = "EnableIPv6")]
    pub enable_i_pv6: Option<bool>,
    /// IPAM property.
    #[serde(rename = "IPAM")]
    pub ipam: Option<IPAM>,
    /// Id property.
    #[serde(rename = "Id")]
    pub id: Option<String>,
    /// Ingress property.
    #[serde(rename = "Ingress")]
    pub ingress: Option<bool>,
    /// Internal property.
    #[serde(rename = "Internal")]
    pub internal: Option<bool>,
    /// Labels property.
    #[serde(rename = "Labels")]
    pub labels: Option<serde_json::Value>,
    /// Name property.
    #[serde(rename = "Name")]
    pub name: Option<String>,
    /// Options property.
    #[serde(rename = "Options")]
    pub options: Option<serde_json::Value>,
    /// Peers property.
    #[serde(rename = "Peers")]
    pub peers: Option<Vec<PeerInfo>>,
    /// Scope property.
    #[serde(rename = "Scope")]
    pub scope: Option<String>,
}

/// `NetworkStatus` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct NetworkStatus {
    /// IPAM property.
    #[serde(rename = "IPAM")]
    pub ipam: Option<IPAMStatus>,
}

/// `IPAM` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct IPAM {
    /// Config property.
    #[serde(rename = "Config")]
    pub config: Option<Vec<IPAMConfig>>,
    /// Driver property.
    #[serde(rename = "Driver")]
    pub driver: Option<String>,
    /// Options property.
    #[serde(rename = "Options")]
    pub options: Option<serde_json::Value>,
}

/// `IPAMStatus` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct IPAMStatus {
    /// Subnets property.
    #[serde(rename = "Subnets")]
    pub subnets: Option<serde_json::Value>,
}

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

/// Arguments for [`NetworkList_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct NetworkListArgs {
    /// Query parameter: `filters`.
    pub filters: Option<String>,
}

/// Arguments for [`NetworkInspect_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct NetworkInspectArgs {
    /// Path parameter: `id`.
    pub id: String,
    /// Query parameter: `verbose`.
    pub verbose: Option<String>,
    /// Query parameter: `scope`.
    pub scope: Option<String>,
}

/// Arguments for [`NetworkDelete_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct NetworkDeleteArgs {
    /// Path parameter: `id`.
    pub id: String,
}

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

// -----------------------------------------------------------------------------
// GET /networks
// -----------------------------------------------------------------------------

/// GET /networks.
///
/// Takes a `DynNetClient` and args, builds the request, optionally applies
/// modifications, then sends it via `send_async().await`.
///
/// # Arguments
///
/// * `client` - HTTP client for making the request
/// * `args` - Request arguments (path params, query params, body)
/// * `builder_mod` - Optional closure to modify the request builder (e.g., add headers)
///
/// # Example
///
/// ```ignore
/// let response = network_list_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn network_list_request<F>(
    client: DynNetClient,
    args: &NetworkListArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<serde_json::Value>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/networks",
    );
    let endpoint_url = format!("{}{}", base_url, path);

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

    builder = builder.query("filters", args.filters.as_deref());

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

    let response = client.send_async(builder.build()).await
        .map_err(|e| super::shared::ApiError::RequestSendFailed(e.to_string()))?;

    let status: usize = response.get_status().into();
    let headers = response.get_headers_ref().clone();
    if status < 200 || status >= 300 {
        return Err(super::shared::ApiError::HttpStatus { code: status as u16, headers, body: None });
    }
    let body_bytes = foundation_netio::shared::client::body_reader::collect_bytes_from_send_safe(response.take_body());
    let parsed: serde_json::Value = serde_json::from_slice(&body_bytes).map_err(|e: serde_json::Error| super::shared::ApiError::ParseFailed(e.to_string()))?;
    Ok(ApiResponse { status: status as u16, headers, body: parsed })
}

// -----------------------------------------------------------------------------
// GET /networks/{id}
// -----------------------------------------------------------------------------

/// GET /networks/{id}.
///
/// Takes a `DynNetClient` and args, builds the request, optionally applies
/// modifications, then sends it via `send_async().await`.
///
/// # Arguments
///
/// * `client` - HTTP client for making the request
/// * `args` - Request arguments (path params, query params, body)
/// * `builder_mod` - Optional closure to modify the request builder (e.g., add headers)
///
/// # Example
///
/// ```ignore
/// let response = network_inspect_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn network_inspect_request<F>(
    client: DynNetClient,
    args: &NetworkInspectArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<NetworkInspect>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/networks/{}",
        args.id,
    );
    let endpoint_url = format!("{}{}", base_url, path);

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

    builder = builder.query("verbose", args.verbose.as_deref());
    builder = builder.query("scope", args.scope.as_deref());

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

    let response = client.send_async(builder.build()).await
        .map_err(|e| super::shared::ApiError::RequestSendFailed(e.to_string()))?;

    let status: usize = response.get_status().into();
    let headers = response.get_headers_ref().clone();
    if status < 200 || status >= 300 {
        return Err(super::shared::ApiError::HttpStatus { code: status as u16, headers, body: None });
    }
    let body_bytes = foundation_netio::shared::client::body_reader::collect_bytes_from_send_safe(response.take_body());
    let parsed: NetworkInspect = serde_json::from_slice(&body_bytes).map_err(|e: serde_json::Error| super::shared::ApiError::ParseFailed(e.to_string()))?;
    Ok(ApiResponse { status: status as u16, headers, body: parsed })
}

// -----------------------------------------------------------------------------
// DELETE /networks/{id}
// -----------------------------------------------------------------------------

/// DELETE /networks/{id}.
///
/// Takes a `DynNetClient` and args, builds the request, optionally applies
/// modifications, then sends it via `send_async().await`.
///
/// # Arguments
///
/// * `client` - HTTP client for making the request
/// * `args` - Request arguments (path params, query params, body)
/// * `builder_mod` - Optional closure to modify the request builder (e.g., add headers)
///
/// # Example
///
/// ```ignore
/// let response = network_delete_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn network_delete_request<F>(
    client: DynNetClient,
    args: &NetworkDeleteArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<()>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/networks/{}",
        args.id,
    );
    let endpoint_url = format!("{}{}", base_url, path);

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

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

    let response = client.send_async(builder.build()).await
        .map_err(|e| super::shared::ApiError::RequestSendFailed(e.to_string()))?;

    let status: usize = response.get_status().into();
    let headers = response.get_headers_ref().clone();
    if status < 200 || status >= 300 {
        return Err(super::shared::ApiError::HttpStatus { code: status as u16, headers, body: None });
    }
    Ok(ApiResponse { status: status as u16, headers, body: () })
}