logo
pub struct Client { /* private fields */ }
Expand description

A blocking client to construct and dispatch local requests.

For details, see the top-level documentation. For the async version, see asynchronous::Client.

Example

The following snippet creates a Client from a Rocket instance and dispatches a local POST / request with a body of Hello, world!.

use rocket::local::blocking::Client;

let rocket = rocket::build();
let client = Client::tracked(rocket).expect("valid rocket");
let response = client.post("/")
    .body("Hello, world!")
    .dispatch();

Implementations

Construct a new Client from an instance of Rocket with cookie tracking. This is typically the desired mode of operation for testing.

With cookie tracking enabled, a Client propagates cookie changes made by responses to previously dispatched requests. In other words, succeeding requests reflect changes (additions and removals) made by any prior responses.

Cookie tracking requires synchronization between dispatches. As such, cookie tracking should not be enabled if a local client is being used to serve requests on multiple threads.

Errors

If launching the Rocket instance would fail, excepting network errors, the Error is returned.

use rocket::local::blocking::Client;

let rocket = rocket::build();
let client = Client::tracked(rocket);

Construct a new Client from an instance of Rocket without cookie tracking.

Unlike the tracked() constructor, a Client returned from this method does not automatically propagate cookie changes and thus requires no synchronization between dispatches.

Errors

If launching the Rocket instance would fail, excepting network errors, the Error is returned.

use rocket::local::blocking::Client;

let rocket = rocket::build();
let client = Client::untracked(rocket);

Terminates Client by initiating a graceful shutdown via Shutdown::notify() and running shutdown fairings.

This method must be called on a Client if graceful shutdown is required for testing as Drop does not signal Shutdown nor run shutdown fairings. Returns the instance of Rocket being managed by this client after all shutdown fairings run to completion.

use rocket::local::blocking::Client;

let client: Client = client;
let rocket = client.terminate();
👎 Deprecated since 0.5.0:

choose between Client::untracked() and Client::tracked()

Deprecated alias to Client::tracked().

Returns a reference to the Rocket this client is creating requests for.

Example
use rocket::local::blocking::Client;

let client: &Client = client;
let rocket = client.rocket();

Returns a cookie jar containing all of the cookies this client is currently tracking.

If cookie tracking is disabled, the returned jar will always be empty. Otherwise, it will contains all of the cookies collected from responses to requests dispatched by this client that have not expired.

Example
use rocket::local::blocking::Client;

let client: &Client = client;
let cookie = client.cookies();

Create a local GET request to the URI uri.

When dispatched, the request will be served by the instance of Rocket within self. The request is not dispatched automatically. To actually dispatch the request, call LocalRequest::dispatch() on the returned request.

Example
use rocket::local::blocking::Client;

let client: &Client = client;
let req = client.get("/hello");

Create a local PUT request to the URI uri.

When dispatched, the request will be served by the instance of Rocket within self. The request is not dispatched automatically. To actually dispatch the request, call LocalRequest::dispatch() on the returned request.

Example
use rocket::local::blocking::Client;

let client: &Client = client;
let req = client.put("/hello");

Create a local POST request to the URI uri.

When dispatched, the request will be served by the instance of Rocket within self. The request is not dispatched automatically. To actually dispatch the request, call LocalRequest::dispatch() on the returned request.

Example
use rocket::local::blocking::Client;

let client: &Client = client;
let req = client.post("/hello");

Create a local DELETE request to the URI uri.

When dispatched, the request will be served by the instance of Rocket within self. The request is not dispatched automatically. To actually dispatch the request, call LocalRequest::dispatch() on the returned request.

Example
use rocket::local::blocking::Client;

let client: &Client = client;
let req = client.delete("/hello");

Create a local OPTIONS request to the URI uri.

When dispatched, the request will be served by the instance of Rocket within self. The request is not dispatched automatically. To actually dispatch the request, call LocalRequest::dispatch() on the returned request.

Example
use rocket::local::blocking::Client;

let client: &Client = client;
let req = client.options("/hello");

Create a local HEAD request to the URI uri.

When dispatched, the request will be served by the instance of Rocket within self. The request is not dispatched automatically. To actually dispatch the request, call LocalRequest::dispatch() on the returned request.

Example
use rocket::local::blocking::Client;

let client: &Client = client;
let req = client.head("/hello");

Create a local PATCH request to the URI uri.

When dispatched, the request will be served by the instance of Rocket within self. The request is not dispatched automatically. To actually dispatch the request, call LocalRequest::dispatch() on the returned request.

Example
use rocket::local::blocking::Client;

let client: &Client = client;
let req = client.patch("/hello");

Create a local GET request to the URI uri.

When dispatched, the request will be served by the instance of Rocket within self. The request is not dispatched automatically. To actually dispatch the request, call LocalRequest::dispatch() on the returned request.

Example
use rocket::local::blocking::Client;
use rocket::http::Method;

let client: &Client = client;
client.req(Method::Get, "/hello");

Trait Implementations

Formats the value using the given formatter. Read more

Executes the destructor for this type. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

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

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

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

Converts self into a collection.

Should always be Self

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

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

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