http1::request

Struct Builder

source
pub struct Builder { /* private fields */ }
Expand description

A builder for constructing Request objects.

The Builder allows setting the HTTP method, version, URL, and headers before building the final Request with a body.

Implementations§

source§

impl Builder

source

pub fn new() -> Self

Creates a new Builder with default values:

  • GET method
  • HTTP/1.1 version
  • URL set to “/”
  • Empty headers
source

pub fn version(self, version: Version) -> Self

Sets the HTTP version of the request.

§Parameters
  • version: The HTTP version to set (e.g., Version::Http1_1).
§Returns

The updated Builder.

source

pub fn version_mut(&mut self) -> Option<&mut Version>

Returns a mutable reference to the HTTP version.

source

pub fn method(self, method: Method) -> Self

Sets the HTTP method of the request.

§Parameters
  • method: The HTTP method to set (e.g., Method::POST).
§Returns

The updated Builder.

source

pub fn method_mut(&mut self) -> Option<&mut Method>

Returns a mutable reference to the HTTP method.

source

pub fn extensions_mut(&mut self) -> Option<&mut Extensions>

Returns a mutable reference to the extensions.

source

pub fn uri<T>(self, uri: T) -> Self
where T: TryInto<Uri>, T::Error: Into<InvalidUri>,

Sets the URL of the request.

§Parameters
  • url: The URL to set.
§Returns

The updated Builder.

source

pub fn uri_mut(&mut self) -> Option<&mut Uri>

Returns a mutable reference to the URL.

source

pub fn headers(&self) -> Option<&Headers>

Returns a reference to the headers being set in the Builder.

source

pub fn headers_mut(&mut self) -> Option<&mut Headers>

Returns a mutable reference to the headers being set in the Builder.

source

pub fn insert_header<K, V>(self, name: K, value: V) -> Self

Inserts a header into the request.

If the header already exists, it is replaced.

§Parameters
  • key: The name of the header.
  • value: The value of the header.
§Returns

The updated Builder.

source

pub fn append_header<K, V>(self, name: K, value: V) -> Self

Appends a value to an existing header in the request.

If the header does not exist, it is created.

§Parameters
  • key: The name of the header.
  • value: The value to append.
§Returns

The updated Builder.

source

pub fn body<T>(self, body: T) -> Result<Request<T>, InvalidRequest>

Builds the final Request with the provided body.

§Parameters
  • body: The content to include in the request body.
§Returns

A Request with the method, version, URL, headers, and body.

Trait Implementations§

source§

impl Default for Builder

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.