Struct AsyncReadBody

pub struct AsyncReadBody { /* private fields */ }

Available on crate feature async-read-body only.

An HttpBody created from an AsyncRead.

Example

AsyncReadBody can be used to stream the contents of a file:

use axum::{
    Router,
    routing::get,
    http::{StatusCode, header::CONTENT_TYPE},
    response::{Response, IntoResponse},
};
use axum_extra::body::AsyncReadBody;
use tokio::fs::File;

async fn cargo_toml() -> Result<Response, (StatusCode, String)> {
    let file = File::open("Cargo.toml")
        .await
        .map_err(|err| {
            (StatusCode::NOT_FOUND, format!("File not found: {err}"))
        })?;

    let headers = [(CONTENT_TYPE, "text/x-toml")];
    let body = AsyncReadBody::new(file);
    Ok((headers, body).into_response())
}

let app = Router::new().route("/Cargo.toml", get(cargo_toml));

Implementations

impl AsyncReadBody

pub fn new<R>(read: R) -> Self

where R: AsyncRead + Send + 'static,

Create a new AsyncReadBody.

Trait Implementations

impl Body for AsyncReadBody

type Data = Bytes

Values yielded by the Body.

type Error = Error

The error type this Body might generate.

fn poll_frame( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<Self::Data>, Self::Error>>>

Attempt to pull out the next data buffer of this stream.

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached.

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream.

impl Debug for AsyncReadBody

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

Formats the value using the given formatter.

impl IntoResponse for AsyncReadBody

fn into_response(self) -> Response

Create a response.

impl<'__pin> Unpin for AsyncReadBody

where PinnedFieldsOf<__Origin<'__pin>>: Unpin,