Skip to main content

TypedClient

Struct TypedClient 

Source
pub struct TypedClient<C, M> { /* private fields */ }
Expand description

A strongly-typed view over any Client, carrying a StateMachine’s command/query/response types so callers work with real Rust values instead of postcard byte vectors.

let typed: TypedClient<RemoteClient, KvMachine> = TypedClient::new(remote);
let resp = typed.propose(&KvCommand::Set { key, value }).await?;

Implementations§

Source§

impl<C, M> TypedClient<C, M>

Source

pub fn new(inner: C) -> Self

Wrap a raw Client with M’s types.

Source

pub fn inner(&self) -> &C

Borrow the underlying raw client.

Source

pub fn into_inner(self) -> C

Unwrap back to the raw client.

Source§

impl<C: Client, M: StateMachine> TypedClient<C, M>

Source

pub async fn propose( &self, command: &M::Command, ) -> Result<M::Response, ClientError>

Propose a typed command and decode the typed response.

§Errors

ClientError::Codec if the command cannot be encoded or the response cannot be decoded, otherwise any error from the underlying Client.

Source

pub async fn query(&self, query: &M::Query) -> Result<M::Response, ClientError>

Run a typed linearizable query and decode the typed response.

§Errors

ClientError::Codec if the query cannot be encoded or the response cannot be decoded, otherwise any error from the underlying Client.

Source§

impl<C: KeyedClient, M: StateMachine> TypedClient<C, M>

Source

pub async fn propose_keyed( &self, key: &[u8], command: &M::Command, ) -> Result<M::Response, ClientError>

Propose a typed command to the Raft group that owns key.

§Errors

ClientError::Codec if the command cannot be encoded or the response cannot be decoded, otherwise any error from the underlying KeyedClient.

Source

pub async fn query_keyed( &self, key: &[u8], query: &M::Query, ) -> Result<M::Response, ClientError>

Run a typed linearizable query against the Raft group that owns key.

§Errors

ClientError::Codec if the query cannot be encoded or the response cannot be decoded, otherwise any error from the underlying KeyedClient.

Auto Trait Implementations§

§

impl<C, M> Freeze for TypedClient<C, M>
where C: Freeze, PhantomData<fn() -> M>: Freeze,

§

impl<C, M> RefUnwindSafe for TypedClient<C, M>

§

impl<C, M> Send for TypedClient<C, M>
where C: Send, PhantomData<fn() -> M>: Send,

§

impl<C, M> Sync for TypedClient<C, M>
where C: Sync, PhantomData<fn() -> M>: Sync,

§

impl<C, M> Unpin for TypedClient<C, M>
where C: Unpin, PhantomData<fn() -> M>: Unpin,

§

impl<C, M> UnsafeUnpin for TypedClient<C, M>

§

impl<C, M> UnwindSafe for TypedClient<C, M>
where C: UnwindSafe, PhantomData<fn() -> M>: UnwindSafe,

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 = !

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