Struct HttpResponseConsumer

Source

pub struct HttpResponseConsumer {
    pub config: ConsumerConfig<HttpResponse>,
    pub http_config: HttpResponseConsumerConfig,
    pub responses: Vec<HttpResponse>,
    pub finished: bool,
}

Expand description

A consumer that converts stream items into HTTP responses.

This consumer accepts HttpResponse items from a pipeline and converts them into Axum Response<Body> that can be sent back to clients. It supports both single-item and multi-item responses, as well as streaming responses.

§Example

use streamweave::http_server::{HttpResponseConsumer, HttpResponseConsumerConfig};
use streamweave::http_server::HttpResponse;
use axum::http::StatusCode;

async fn handle_response(mut consumer: HttpResponseConsumer) {
    let response = consumer.get_response().await;
    // Send response to client
}

Fields§

§config: ConsumerConfig<HttpResponse>

Consumer configuration.

§http_config: HttpResponseConsumerConfig

HTTP response-specific configuration.

§responses: Vec<HttpResponse>

Collected responses.

§finished: bool

Whether the consumer has finished consuming.

Implementations§

Source §

impl HttpResponseConsumer

Source

pub fn new() -> Self

Creates a new HTTP response consumer with default configuration.

§Example

use streamweave::http_server::HttpResponseConsumer;

let consumer = HttpResponseConsumer::new();

Source

pub fn with_config(http_config: HttpResponseConsumerConfig) -> Self

Creates a new HTTP response consumer with custom configuration.

§Example

use streamweave::http_server::{HttpResponseConsumer, HttpResponseConsumerConfig};

let consumer = HttpResponseConsumer::with_config(
    HttpResponseConsumerConfig::default()
        .with_stream_response(true)
        .with_merge_responses(false),
);

Source

pub fn with_error_strategy(self, strategy: ErrorStrategy<HttpResponse>) -> Self

Sets the error strategy for the consumer.

Source

pub fn with_name(self, name: String) -> Self

Sets the name for the consumer.

Source

pub async fn get_response(&mut self) -> Response<Body>

Gets the collected response as an Axum Response.

This should be called after consume has completed. For single-item responses, it returns the first response. For multi-item responses, it merges them according to the configuration.

§Example

use streamweave::http_server::HttpResponseConsumer;

let mut consumer = HttpResponseConsumer::new();
// ... consume stream ...
let axum_response = consumer.get_response().await;

Source

pub async fn create_streaming_response( &self, stream: impl Stream<Item = HttpResponse> + Send + 'static, ) -> Response<Body>

Creates a streaming response from a stream of HttpResponse items.

This method converts a stream of HttpResponse items into a streaming Axum response with chunked transfer encoding. The first response’s status and headers are used, and subsequent responses’ bodies are streamed as chunks.

§Example

use streamweave::http_server::{HttpResponseConsumer, HttpResponse};
use streamweave::consumer::Consumer;
use futures::StreamExt;
use axum::http::StatusCode;

async fn stream_responses(mut stream: impl futures::Stream<Item = HttpResponse> + Send) {
    let consumer = HttpResponseConsumer::new();
    let response = consumer.create_streaming_response(stream).await;
    // Send response to client
}