Struct OutgoingRequest 

pub struct OutgoingRequest { /* private fields */ }

Represents an outgoing HTTP Request.

Implementations

impl OutgoingRequest

pub fn new(headers: Headers) -> Self

Construct a new outgoing-request with a default method of GET, and none values for path-with-query, scheme, and authority.

• headers is the HTTP Headers for the Request.

It is possible to construct, or manipulate with the accessor functions below, an outgoing-request with an invalid combination of scheme and authority, or headers which are not permitted to be sent. It is the obligation of the outgoing-handler.handle implementation to reject invalid constructions of outgoing-request.

impl OutgoingRequest

pub fn body(&self) -> Result<OutgoingBody, ()>

Returns the resource corresponding to the outgoing Body for this Request.

Returns success on the first call: the outgoing-body resource for this outgoing-request can be retrieved at most once. Subsequent calls will return error.

impl OutgoingRequest

pub fn method(&self) -> Method

Get the Method for the Request.

impl OutgoingRequest

pub fn set_method(&self, method: &Method) -> Result<(), ()>

Set the Method for the Request. Fails if the string present in a method.other argument is not a syntactically valid method.

impl OutgoingRequest

pub fn path_with_query(&self) -> Option<String>

Get the combination of the HTTP Path and Query for the Request. When none, this represents an empty Path and empty Query.

impl OutgoingRequest

pub fn set_path_with_query( &self, path_with_query: Option<&str>, ) -> Result<(), ()>

Set the combination of the HTTP Path and Query for the Request. When none, this represents an empty Path and empty Query. Fails is the string given is not a syntactically valid path and query uri component.

impl OutgoingRequest

pub fn scheme(&self) -> Option<Scheme>

Get the HTTP Related Scheme for the Request. When none, the implementation may choose an appropriate default scheme.

impl OutgoingRequest

pub fn set_scheme(&self, scheme: Option<&Scheme>) -> Result<(), ()>

Set the HTTP Related Scheme for the Request. When none, the implementation may choose an appropriate default scheme. Fails if the string given is not a syntactically valid uri scheme.

impl OutgoingRequest

pub fn authority(&self) -> Option<String>

Get the HTTP Authority for the Request. A value of none may be used with Related Schemes which do not require an Authority. The HTTP and HTTPS schemes always require an authority.

impl OutgoingRequest

pub fn set_authority(&self, authority: Option<&str>) -> Result<(), ()>

Set the HTTP Authority for the Request. A value of none may be used with Related Schemes which do not require an Authority. The HTTP and HTTPS schemes always require an authority. Fails if the string given is not a syntactically valid uri authority.

impl OutgoingRequest

pub fn headers(&self) -> Headers

Get the headers associated with the Request.

The returned headers resource is immutable: set, append, and delete operations will fail with header-error.immutable.

This headers resource is a child: it must be dropped before the parent outgoing-request is dropped, or its ownership is transfered to another component by e.g. outgoing-handler.handle.

impl OutgoingRequest

pub fn take_body(&self) -> impl Sink<Vec<u8>, Error = StreamError>

Construct a Sink which writes chunks to the body of the specified response.

Panics

Panics if the body was already taken.

Trait Implementations

impl Debug for OutgoingRequest

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

Formats the value using the given formatter.

impl TryIntoOutgoingRequest for OutgoingRequest

type Error = Infallible

The error if the conversion fails

fn try_into_outgoing_request( self, ) -> Result<(OutgoingRequest, Option<Vec<u8>>), Self::Error>

Turn the type into an OutgoingRequest