Skip to main content

HttpRequest

mockserver_client

Struct HttpRequest

pub struct HttpRequest {
    pub method: Option<String>,
    pub path: Option<String>,
    pub query_string_parameters: Option<HashMap<String, Vec<String>>>,
    pub headers: Option<HashMap<String, Vec<String>>>,
    pub body: Option<Body>,
    pub socket_address: Option<SocketAddress>,
}

Expand description

Matcher for an HTTP request. Uses builder methods for fluent construction.

§Example

use mockserver_client::HttpRequest;

let request = HttpRequest::new()
    .method("POST")
    .path("/api/users")
    .header("Content-Type", "application/json")
    .query_param("page", "1")
    .body("{}");

Fields§

§method: Option<String>§path: Option<String>§query_string_parameters: Option<HashMap<String, Vec<String>>>§headers: Option<HashMap<String, Vec<String>>>§body: Option<Body>§socket_address: Option<SocketAddress>

Implementations§

impl HttpRequest

pub fn new() -> Self

Create a new empty request matcher.

pub fn socket_address(self, socket_address: SocketAddress) -> Self

Set the downstream socket address to connect to.

Used by load-scenario steps (and forwarded/proxied requests) to direct the rendered request at a specific host/port/scheme rather than relying on the request’s Host header.

pub fn method(self, method: impl Into<String>) -> Self

Set the HTTP method to match.

pub fn path(self, path: impl Into<String>) -> Self

Set the path to match.

pub fn query_param( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add a query string parameter (multiple values per key supported).

Add a header (multiple values per key supported).

pub fn body(self, body: impl Into<String>) -> Self

Set a plain string body matcher.

pub fn json_body(self, json: Value) -> Self

Set a typed JSON body matcher.

pub fn file_body(self, file_path: impl Into<String>) -> Self

Set a file body (type “FILE”) with optional content type and template type.

Use Body::file for richer construction if you need content type or template type set.

pub fn body_value(self, body: Body) -> Self

Set a pre-built Body value (use with Body::file for FILE bodies).

Trait Implementations§

impl Clone for HttpRequest

fn clone(&self) -> HttpRequest

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

impl Debug for HttpRequest

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

Formats the value using the given formatter. Read more

impl Default for HttpRequest

fn default() -> HttpRequest

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

impl<'de> Deserialize<'de> for HttpRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for HttpRequest

fn eq(&self, other: &HttpRequest) -> 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.

impl Serialize for HttpRequest

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for HttpRequest

Auto Trait Implementations§

impl Freeze for HttpRequest

impl RefUnwindSafe for HttpRequest

impl Send for HttpRequest

impl Sync for HttpRequest

impl Unpin for HttpRequest

impl UnsafeUnpin for HttpRequest

impl UnwindSafe for HttpRequest

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

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

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> From<T> for T

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

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

fn into(self) -> U

Calls U::from(self).

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

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

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

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

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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