Struct StreamBody 

pub struct StreamBody {
    pub stream: Arc<Mutex<Option<BoxStream<'static, Result<Bytes, CamelError>>>>>,
    pub metadata: StreamMetadata,
}

A body that wraps a lazy-evaluated stream of bytes.

Clone Semantics

The stream is single-consumption. When cloning a Body::Stream, all clones share the same underlying stream handle. Only the first clone to consume the stream will succeed; subsequent attempts will return CamelError::AlreadyConsumed.

Example

use camel_api::{Body, StreamBody, error::CamelError};
use futures::stream;
use bytes::Bytes;
use std::sync::Arc;
use tokio::sync::Mutex;

let chunks = vec![Ok(Bytes::from("data"))];
let stream = stream::iter(chunks);
let body = Body::Stream(StreamBody {
    stream: Arc::new(Mutex::new(Some(Box::pin(stream)))),
    metadata: Default::default(),
});

let clone = body.clone();

// First consumption succeeds
let _ = body.into_bytes(1024).await?;

// Second consumption fails
let result = clone.into_bytes(1024).await;
assert!(matches!(result, Err(CamelError::AlreadyConsumed)));

Fields

stream: Arc<Mutex<Option<BoxStream<'static, Result<Bytes, CamelError>>>>>

The actual byte stream, wrapped in an Arc and Mutex to allow Clone for Body.

metadata: StreamMetadata

Metadata associated with the stream.

Trait Implementations

impl Clone for StreamBody

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamBody

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

Formats the value using the given formatter.