Skip to main content

RequestBuilder

Struct RequestBuilder 

Source
pub struct RequestBuilder { /* private fields */ }
Expand description

Builder for constructing Request instances.

Provides a fluent API for building HTTP requests with optional parameters.

§Examples

use reinhardt_http::Request;
use hyper::Method;

let request = Request::builder()
    .method(Method::GET)
    .uri("/api/users?page=1")
    .build()
    .unwrap();

assert_eq!(request.method, Method::GET);
assert_eq!(request.path(), "/api/users");
assert_eq!(request.query_params.get("page"), Some(&"1".to_string()));

Implementations§

Source§

impl RequestBuilder

Source

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

Set the HTTP method.

§Examples
use reinhardt_http::Request;
use hyper::Method;

let request = Request::builder()
    .method(Method::POST)
    .uri("/api/users")
    .build()
    .unwrap();

assert_eq!(request.method, Method::POST);
Source

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

Set the request URI.

Accepts either a &str or Uri. Query parameters will be automatically parsed.

§Examples
use reinhardt_http::Request;
use hyper::Method;

let request = Request::builder()
    .method(Method::GET)
    .uri("/api/users?page=1&limit=10")
    .build()
    .unwrap();

assert_eq!(request.path(), "/api/users");
assert_eq!(request.query_params.get("page"), Some(&"1".to_string()));
assert_eq!(request.query_params.get("limit"), Some(&"10".to_string()));
Source

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

Set the HTTP version.

Defaults to HTTP/1.1 if not specified.

§Examples
use reinhardt_http::Request;
use hyper::{Method, Version};

let request = Request::builder()
    .method(Method::GET)
    .uri("/api/users")
    .version(Version::HTTP_2)
    .build()
    .unwrap();

assert_eq!(request.version, Version::HTTP_2);
Source

pub fn headers(self, headers: HeaderMap) -> Self

Set the request headers.

Replaces all existing headers.

§Examples
use reinhardt_http::Request;
use hyper::{Method, HeaderMap, header};

let mut headers = HeaderMap::new();
headers.insert(header::CONTENT_TYPE, "application/json".parse().unwrap());

let request = Request::builder()
    .method(Method::POST)
    .uri("/api/users")
    .headers(headers.clone())
    .build()
    .unwrap();

assert_eq!(request.headers.get(header::CONTENT_TYPE).unwrap(), "application/json");
Source

pub fn header<K, V>(self, key: K, value: V) -> Self

Add a single header to the request.

§Examples
use reinhardt_http::Request;
use hyper::{Method, header};

let request = Request::builder()
    .method(Method::POST)
    .uri("/api/users")
    .header(header::CONTENT_TYPE, "application/json")
    .header(header::AUTHORIZATION, "Bearer token123")
    .build()
    .unwrap();

assert_eq!(request.headers.get(header::CONTENT_TYPE).unwrap(), "application/json");
assert_eq!(request.headers.get(header::AUTHORIZATION).unwrap(), "Bearer token123");
Source

pub fn body(self, body: Bytes) -> Self

Set the request body.

§Examples
use reinhardt_http::Request;
use hyper::Method;
use bytes::Bytes;

let body = Bytes::from(r#"{"name":"Alice"}"#);
let request = Request::builder()
    .method(Method::POST)
    .uri("/api/users")
    .body(body.clone())
    .build()
    .unwrap();

assert_eq!(request.body(), &body);
Source

pub fn secure(self, is_secure: bool) -> Self

Set whether the request is secure (HTTPS).

Defaults to false if not specified.

§Examples
use reinhardt_http::Request;
use hyper::Method;

let request = Request::builder()
    .method(Method::GET)
    .uri("/")
    .secure(true)
    .build()
    .unwrap();

assert!(request.is_secure());
assert_eq!(request.scheme(), "https");
Source

pub fn remote_addr(self, addr: SocketAddr) -> Self

Set the remote address of the client.

§Examples
use reinhardt_http::Request;
use hyper::Method;
use std::net::{SocketAddr, IpAddr, Ipv4Addr};

let addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
let request = Request::builder()
    .method(Method::GET)
    .uri("/")
    .remote_addr(addr)
    .build()
    .unwrap();

assert_eq!(request.remote_addr, Some(addr));
Source

pub fn parser<P: Parser + 'static>(self, parser: P) -> Self

Add a parser to the request.

Parsers are used to parse the request body into specific formats. The parser will be boxed internally.

§Examples
use reinhardt_http::Request;
use hyper::Method;

let request = Request::builder()
    .method(Method::POST)
    .uri("/api/users")
    .parser(JsonParser::new())
    .build()
    .unwrap();
Source

pub fn path_params(self, params: HashMap<String, String>) -> Self

Set path parameters (used for testing views without router).

This is primarily useful in test environments where you need to simulate path parameters that would normally be extracted by the router.

§Examples
use reinhardt_http::Request;
use hyper::Method;
use std::collections::HashMap;

let mut params = HashMap::new();
params.insert("id".to_string(), "42".to_string());

let request = Request::builder()
    .method(Method::GET)
    .uri("/api/users/42")
    .path_params(params)
    .build()
    .unwrap();

assert_eq!(request.path_params.get("id"), Some(&"42".to_string()));
Source

pub fn build(self) -> Result<Request, String>

Build the final Request instance.

Returns an error if the URI is missing.

§Examples
use reinhardt_http::Request;
use hyper::Method;

let request = Request::builder()
    .method(Method::GET)
    .uri("/api/users")
    .build()
    .unwrap();

assert_eq!(request.method, Method::GET);
assert_eq!(request.path(), "/api/users");

Trait Implementations§

Source§

impl Default for RequestBuilder

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> 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<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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