Skip to main content

CacheClientBuilder

Struct CacheClientBuilder 

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

Builder for a CacheClient. Created by CacheClient::builder.

Implementations§

Source§

impl CacheClientBuilder

Source

pub fn cache(self, range: impl AsRange) -> Self

Add a key, range, or prefix whose contents should live in the cache.

Overlapping ranges are allowed but each maintains an independent copy of the overlap. etcd has no empty key, so cache("") caches no keys, while cache(..) caches every key.

Source

pub fn cache_prefix(self, prefix: impl AsKey) -> Self

Add a prefix whose contents should live in the cache.

Equivalent to calling cache with a Prefix query.

Source

pub fn build_on(self, runtime: &Handle) -> CacheClient

Build the cache client using the provided Tokio runtime handle.

This is equivalent to calling build from within a Tokio runtime, but allows you to specify the runtime explicitly.

Source

pub fn build(self) -> CacheClient

Spawn the coherence task and return the cache handle.

Construction never fails and does not wait for the cache to warm: the returned handle is usable immediately, and reads of a configured range pass through to the server until that range’s initial seed completes in the background. With no configured ranges the cache is a plain passthrough.

§Panics

Panics if called from outside a Tokio runtime, which is required to spawn the background coherence task. Use build_on to provide a runtime handle explicitly.

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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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, !>

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