Skip to main content

Request

Struct Request 

Source
#[non_exhaustive]
pub struct Request { pub method: Method, pub url: String, pub headers: Vec<(String, String)>, pub body: Option<Vec<u8>>, }
Expand description

A request that wafrift can transform.

Intentionally simple — no HTTP library dependency. The transport layer converts to/from reqwest::Request or raw bytes as needed.

§Construction

Use the provided constructors (Request::get, Request::post, etc.) and builder methods (Request::header, Request::with_body). Direct struct construction is prevented by #[non_exhaustive].

§Examples

Build a GET request, attach a header, then a JSON POST body:

use wafrift_types::request::{Method, Request};

let r = Request::get("https://example.com/api")
    .header("Accept", "application/json");
assert_eq!(r.method(), &Method::Get);
assert_eq!(r.url(), "https://example.com/api");
assert_eq!(r.headers().len(), 1);
assert_eq!(r.get_header("Accept"), Some("application/json"));
assert!(!r.has_body());

let r = Request::post("https://example.com/login", b"u=admin&p=admin".to_vec());
assert_eq!(r.method(), &Method::Post);
assert_eq!(r.body_bytes().unwrap(), b"u=admin&p=admin");

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§method: Method

HTTP method.

§url: String

Full request URL.

§headers: Vec<(String, String)>

Request headers as (name, value) pairs.

§body: Option<Vec<u8>>

Optional request body.

Implementations§

Source§

impl Request

Source

pub fn get(url: impl Into<String>) -> Request

Create a GET request.

Source

pub fn post(url: impl Into<String>, body: impl Into<Vec<u8>>) -> Request

Create a POST request with a body.

Source

pub fn put(url: impl Into<String>, body: impl Into<Vec<u8>>) -> Request

Create a PUT request with a body.

Source

pub fn delete(url: impl Into<String>) -> Request

Create a DELETE request.

Source

pub fn with_method(method: impl Into<Method>, url: impl Into<String>) -> Request

Create a request with an arbitrary method.

Source

pub fn method(&self) -> &Method

Returns a reference to the HTTP method.

Source

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

Returns a mutable reference to the HTTP method.

Source

pub fn url(&self) -> &str

Returns the URL as a string slice.

Source

pub fn url_mut(&mut self) -> &mut String

Returns a mutable reference to the URL.

Source

pub fn headers(&self) -> &[(String, String)]

Returns a slice of the header pairs.

Source

pub fn headers_mut(&mut self) -> &mut Vec<(String, String)>

Returns a mutable reference to the headers vec.

Source

pub fn body_bytes(&self) -> Option<&[u8]>

Returns a reference to the body, if present.

Source

pub fn set_body(&mut self, body: impl Into<Vec<u8>>)

Sets the body, replacing any existing body.

Source

pub fn clear_body(&mut self)

Clears the body.

Source

pub fn header( self, name: impl Into<String>, value: impl Into<String>, ) -> Request

Add a header to the request (builder pattern).

Source

pub fn add_header(&mut self, name: impl Into<String>, value: impl Into<String>)

Add a header to the request (mutable reference version).

Source

pub fn with_body(self, body: impl Into<Vec<u8>>) -> Request

Set the request body.

Source

pub fn get_header(&self, name: &str) -> Option<&str>

Get the value of a header by name (case-insensitive).

Source

pub fn get_headers(&self, name: &str) -> Vec<&str>

Get all values for a header name (case-insensitive).

Source

pub fn content_type(&self) -> Option<&str>

Get the Content-Type header value.

Source

pub fn has_body(&self) -> bool

Check if this request has a body.

Source

pub fn body_str(&self) -> Option<&str>

Get the body as a UTF-8 string, if present and valid.

Trait Implementations§

Source§

impl Clone for Request

Source§

fn clone(&self) -> Request

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Request

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Request

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<Request, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Request

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Request

Source§

fn eq(&self, other: &Request) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Request

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Request

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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