Struct redis::cluster::ClusterClientBuilder

source · [−]

pub struct ClusterClientBuilder { /* private fields */ }

Available on crate feature cluster only.

Expand description

Used to configure and build a ClusterClient.

Implementations

impl ClusterClientBuilder

pub fn new<T: IntoConnectionInfo>(initial_nodes: Vec<T>) -> ClusterClientBuilder

Generate the base configuration for new Client.

pub fn open(self) -> RedisResult<ClusterClient>

Builds a ClusterClient. Despite the name, this does not actually open a connection to Redis Cluster, but will perform some basic checks of the initial nodes’ URLs and passwords.

Errors

Upon failure to parse initial nodes or if the initial nodes have different passwords, an error is returned.

pub fn password(self, password: String) -> ClusterClientBuilder

Set password for new ClusterClient.

pub fn readonly(self, readonly: bool) -> ClusterClientBuilder

Set read only mode for new ClusterClient (default is false). If readonly is true, all queries will go to replica nodes. If there are no replica nodes, queries will be issued to the primary nodes.

Auto Trait Implementations

impl !RefUnwindSafe for ClusterClientBuilder

impl Send for ClusterClientBuilder

impl Sync for ClusterClientBuilder

impl Unpin for ClusterClientBuilder

impl !UnwindSafe for ClusterClientBuilder

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · 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.

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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