Skip to main content

Client

Struct Client 

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

The client for mise One instance of this will keep one connection open to the server and it will be closed once this instance is deallocated.

It is possible to batch requests with the plural methods (ex gets instead of get).

Implementations§

Source§

impl Client

Source

pub fn connect(addr: SocketAddr) -> Result<Self, ClientError>

Creates a new client by connecting to a server. Every client instance is one connection.

§Errors

Errors if connection cannot be established.

Source

pub fn get(&mut self, uri: &str) -> Result<Value, ClientError>

Sends a normal GET request.

§Errors

Errors if request fails

Source

pub fn gets<const X: usize>( &mut self, uris: &[&str; X], ) -> Result<[Option<Result<Value, ClientError>>; X], ClientError>

Sends a batch of GET requests sent all at once.

First writes all the requests in the pipe before starting to read back the first response. Effectively this is a batching mode since there is no waiting between sends.

When batching, consider that if the send buffer is full this may block undefinetly as it won’t read the first response until all requests are sent first. This means that the batch number cannot be arbitrarly high but there is a virtual limit that will trigger this behavior and then rend this method stuck in wait mode while trying to write to a full buffer.

§Errors

Errors if request fails

Source

pub fn delete(&mut self, uri: &str) -> Result<Value, ClientError>

Sends a DELETE request.

§Errors

Errors if request fails

Source

pub fn deletes<const X: usize>( &mut self, uris: &[&str; X], ) -> Result<[Option<Result<Value, ClientError>>; X], ClientError>

Batches a DELETE set of requests. For batching, see Self::gets

§Errors

Errors if request fails

Source

pub fn post(&mut self, uri: &str, value: Value) -> Result<Value, ClientError>

Sends a POST request.

§Errors

Errors if request fails

Source

pub fn posts<const X: usize>( &mut self, uris: &[&str; X], values: &[Value; X], ) -> Result<[Option<Result<Value, ClientError>>; X], ClientError>

Batches a POST set of requests. For batching, see Self::gets

§Errors

Errors if request fails

Source

pub fn put(&mut self, uri: &str, value: Value) -> Result<Value, ClientError>

Sends a PUT request.

§Errors

Errors if request fails

Source

pub fn puts<const X: usize>( &mut self, uris: &[&str; X], values: &[Value; X], ) -> Result<[Option<Result<Value, ClientError>>; X], ClientError>

Batches a PUT set of requests. For batching, see Self::gets

§Errors

Errors if request fails

Source

pub fn patch(&mut self, uri: &str, value: Value) -> Result<Value, ClientError>

Sends a PATCH request.

§Errors

Errors if request fails

Source

pub fn patches<const X: usize>( &mut self, uris: &[&str; X], values: &[Value; X], ) -> Result<[Option<Result<Value, ClientError>>; X], ClientError>

Batches a PATCH set of requests. For batching, see Self::gets

§Errors

Errors if request fails

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, 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<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