SendRequest

Struct SendRequest 

pub struct SendRequest<T, B>
where T: OpenStreams<B>, B: Buf,
{ /* private fields */ }
Available on crate features quic and h3 only.
Expand description

HTTP/3 request sender

send_request() initiates a new request and will resolve when it is ready to be sent to the server. Then a RequestStream will be returned to send a request body (for POST, PUT methods) and receive a response. After the whole body is sent, it is necessary to call RequestStream::finish() to let the server know the request transfer is complete. This includes the cases where no body is sent at all.

This struct is cloneable so multiple requests can be sent concurrently.

Existing instances are atomically counted internally, so whenever all of them have been dropped, the connection will be automatically closed with HTTP/3 connection error code HTTP_NO_ERROR = 0.

§Examples

§Sending a request with no body

// Prepare the HTTP request to send to the server
let request = Request::get("https://www.example.com/").body(())?;

// Send the request to the server
let mut req_stream: RequestStream<_, _> = send_request.send_request(request).await?;
// Don't forget to end up the request by finishing the send stream.
req_stream.finish().await?;
// Receive the response
let response: Response<()> = req_stream.recv_response().await?;
// Process the response...

§Sending a request with a body and trailers

// Prepare the HTTP request to send to the server
let request = Request::get("https://www.example.com/").body(())?;

// Send the request to the server
let mut req_stream = send_request.send_request(request).await?;
// Send some data
req_stream.send_data("body".into()).await?;
// Prepare the trailers
let mut trailers = HeaderMap::new();
trailers.insert("trailer", "value".parse()?);
// Send them and finish the send stream
req_stream.send_trailers(trailers).await?;
// We don't need to finish the send stream, as `send_trailers()` did it for us

// Receive the response.
let response = req_stream.recv_response().await?;
// Process the response...

Implementations§

§

impl<T, B> SendRequest<T, B>
where T: OpenStreams<B>, B: Buf,

pub async fn send_request( &mut self, req: Request<()>, ) -> Result<RequestStream<<T as OpenStreams<B>>::BidiStream, B>, StreamError>

Send an HTTP/3 request to the server

Trait Implementations§

§

impl<T, B> Clone for SendRequest<T, B>
where T: OpenStreams<B> + Clone, B: Buf,

§

fn clone(&self) -> SendRequest<T, B>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl<T, B> CloseStream for SendRequest<T, B>
where T: OpenStreams<B>, B: Buf,

§

fn handle_connection_error_on_stream( &mut self, internal_error: InternalConnectionError, ) -> StreamError

Handles a connection error on a stream
§

fn handle_quic_stream_error(&self, error: StreamErrorIncoming) -> StreamError

Handles a incoming stream error from the quic layer
§

fn check_peer_connection_closing(&self) -> Option<StreamError>

Checks if the peer connection is closing an if it is allowed to send a request / server push
§

impl<T, B> ConnectionState for SendRequest<T, B>
where T: OpenStreams<B>, B: Buf,

§

fn shared_state(&self) -> &SharedState

Get the shared state
§

fn get_conn_error(&self) -> Option<ErrorOrigin>

Get the connection error if the connection is in error state because of another task Read more
§

fn set_conn_error(&self, error: ErrorOrigin) -> ErrorOrigin

tries to set the connection error
§

fn set_conn_error_and_wake<T>(&self, error: T) -> ErrorOrigin
where T: Into<ErrorOrigin>,

set the connection error and wake the connection
§

fn settings(&self) -> Cow<'_, Settings>

Get the settings
§

fn set_closing(&self)

Set the connection to closing
§

fn is_closing(&self) -> bool

Check if the connection is closing
§

fn set_settings(&self, settings: Settings)

Set the settings
§

fn waker(&self) -> &AtomicWaker

Returns the waker for the connection
§

impl<T, B> Drop for SendRequest<T, B>
where T: OpenStreams<B>, B: Buf,

§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<T, B> Freeze for SendRequest<T, B>
where T: Freeze,

§

impl<T, B> !RefUnwindSafe for SendRequest<T, B>

§

impl<T, B> Send for SendRequest<T, B>
where T: Send,

§

impl<T, B> Sync for SendRequest<T, B>
where T: Sync,

§

impl<T, B> Unpin for SendRequest<T, B>
where T: Unpin,

§

impl<T, B> !UnwindSafe for SendRequest<T, B>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more