Struct hyper::body::Sender

pub struct Sender {
    want_rx: Receiver,
    data_tx: Sender<Result<Bytes, Error>>,
    trailers_tx: Option<Sender<HeaderMap>>,
}

A sender half created through Body::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.

Fields

want_rx: Receiver

data_tx: Sender<Result<Bytes, Error>>

trailers_tx: Option<Sender<HeaderMap>>

Implementations

impl Sender

pub fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<()>>

Check to see if this Sender can send more data.

fn poll_want(&mut self, cx: &mut Context<'_>) -> Poll<Result<()>>

async fn ready(&mut self) -> Result<()>

pub async fn send_data(&mut self, chunk: Bytes) -> Result<()>

Send data on data channel when it is ready.

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

Send trailers on trailers channel.

pub fn try_send_data(&mut self, chunk: Bytes) -> Result<(), Bytes>

Try to send data on this channel.

Errors

Returns Err(Bytes) if the channel could not (currently) accept another Bytes.

Note

This is mostly useful for when trying to send from some other thread that doesn’t have an async context. If in an async context, prefer send_data() instead.

pub fn abort(self)

Aborts the body in an abnormal fashion.

pub(crate) fn send_error(&mut self, err: Error)

Trait Implementations

impl Debug for Sender

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

Formats the value using the given formatter.