Struct StatsQuery 

pub struct StatsQuery {
    pub stream: bool,
    pub interval: Option<u32>,
}

Query parameters for container stats.

When stream=false (default), the handler returns a single JSON ContainerStatsResponse. When stream=true, the handler switches to Server-Sent Events and emits one ContainerStatsResponse sample per interval seconds until the container exits or the client disconnects.

interval is clamped to [1, 60] seconds. Default interval is 2.

Fields

stream: bool

Stream periodic samples as SSE events instead of a one-shot JSON response.

interval: Option<u32>

Sample cadence in seconds (only used when stream=true). Clamped to [1, 60]. Defaults to 2 seconds.

Trait Implementations

impl Debug for StatsQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StatsQuery

fn default() -> StatsQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StatsQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoParams for StatsQuery

fn into_params( parameter_in_provider: impl Fn() -> Option<ParameterIn>, ) -> Vec<Parameter>

Provide Vec of openapi::path::Parameters to caller. The result is used in utoipa-gen library to provide OpenAPI parameter information for the endpoint using the parameters.