Struct Client

pub struct Client<E, VER: StaticVersionType> { /* private fields */ }

A client of a Tide Disco application.

Implementations

impl<E: Error, VER: StaticVersionType> Client<E, VER>

pub fn new(base_url: Url) -> Self

Create a client and connect to the Tide Disco server at base_url.

pub fn builder(base_url: Url) -> ClientBuilder<E, VER>

Create a client with customization.

pub async fn connect(&self, timeout: Option<Duration>) -> bool

Connect to the server, retrying if the server is not running.

It is not necessary to call this function when creating a new client. The client will automatically connect when a request is made, if the server is available. However, this can be useful to wait for the server to come up, if the server may be offline when the client is created.

This function will make an HTTP GET request to the server’s /healthcheck endpoint, to test if the server is available. If this request succeeds, connect returns true. Otherwise, the client will continue retrying /healthcheck requests until timeout has elapsed (or forever, if timeout is None). If the timeout expires before a /healthcheck request succeeds, connect will return false.

pub async fn wait_for_health<H: DeserializeOwned + HealthCheck>( &self, healthy: impl Fn(&H) -> bool, timeout: Option<Duration>, ) -> Option<H>

Connect to the server, retrying until the server is healthy.

This function is similar to connect. It will make requests to the /healthcheck endpoint until a request succeeds. However, it will then continue retrying until the response from /healthcheck satisfies the healthy predicate.

On success, returns the response from /healthcheck. On timeout, returns None.

pub fn get<T: DeserializeOwned>(&self, route: &str) -> Request<T, E, VER>

Build an HTTP GET request.

pub fn post<T: DeserializeOwned>(&self, route: &str) -> Request<T, E, VER>

Build an HTTP POST request.

pub async fn healthcheck<H: DeserializeOwned + HealthCheck>( &self, ) -> Result<H, E>

Query the server’s healthcheck endpoint.

pub fn request<T: DeserializeOwned>( &self, method: Method, route: &str, ) -> Request<T, E, VER>

Build an HTTP request with the specified method.

pub fn socket(&self, route: &str) -> SocketRequest<E, VER>

Build a streaming connection request.

Panics

This will panic if a malformed URL is passed.

pub fn socket_with_config( &self, route: &str, config: WebSocketConfig, ) -> SocketRequest<E, VER>

Build a streaming connection request using a custom WebSocketConfig.

Panics

This will panic if a malformed URL is passed.

pub fn module<ModError: Error>( &self, prefix: &str, ) -> Result<Client<ModError, VER>, ParseError>

Create a client for a sub-module of the connected application.

pub fn base_url(&self) -> Url

Trait Implementations

impl<E, VER: StaticVersionType> Clone for Client<E, VER>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E, VER: StaticVersionType> Debug for Client<E, VER>

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

Formats the value using the given formatter.

impl<E: Error, VER: StaticVersionType> From<ClientBuilder<E, VER>> for Client<E, VER>

fn from(builder: ClientBuilder<E, VER>) -> Self

Converts to this type from the input type.