Struct salvo_core::http::body::BodySender

pub struct BodySender { /* private fields */ }

A sender half created through [ResBody ::Channel].

Useful when wanting to stream chunks from another thread.

Body Closing

Note that the request body will always be closed normally when the sender is dropped (meaning that the empty terminating chunk will be sent to the remote). If you desire to close the connection with an incomplete response (e.g. in the case of an error during asynchronous processing), call the Sender::abort() method to abort the body in an abnormal fashion.

Implementations

impl BodySender

pub fn is_closed(&self) -> bool

Returns whether this channel is closed without needing a context.

pub fn close(&mut self)

Closes this channel from the sender side, preventing any new messages.

pub fn disconnect(&mut self)

Disconnects this sender from the channel, closing it if there are no more senders left.

pub async fn send_data( &mut self, chunk: impl Into<Bytes> + Send ) -> IoResult<()>

Send data on data channel when it is ready.

pub async fn send_trailers(&mut self, trailers: HeaderMap) -> IoResult<()>

Send trailers on trailers channel.

pub fn send_error(&mut self, err: IoError)

Send error on data channel.

Trait Implementations

impl AsyncWrite for BodySender

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8] ) -> Poll<IoResult<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<IoResult<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<IoResult<()>>

Attempt to close the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>] ) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl AsyncWrite for BodySender

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8] ) -> Poll<IoResult<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<IoResult<()>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown( self: Pin<&mut Self>, _cx: &mut Context<'_> ) -> Poll<IoResult<()>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>] ) -> Poll<Result<usize, Error>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl Debug for BodySender

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

Formats the value using the given formatter.