SentinelClientBuilder in redis::sentinel - Rust
Description: Used to configure and build a `SentinelClient`. There are two connections that can be configured independently

Skip to main content

## SentinelClientBuilder

# Struct SentinelClientBuilder

Source

    pub struct SentinelClientBuilder { /* private fields */ }

Available on crate feature `sentinel` only.
Expand description

Used to configure and build a `SentinelClient`. There are two connections that can be configured independently

1. The connection towards the redis nodes (configured via `set_client_to_redis_..` functions)
2. The connection towards the sentinel nodes (configure via `set_client_to_sentinel_..` functions)

## Implementations§

Source§

### impl SentinelClientBuilder

Source

#### pub fn new<T: IntoIterator<Item = ConnectionAddr>>( sentinels: T, service_name: impl AsRef<str>, server_type: SentinelServerType, ) -> RedisResult<SentinelClientBuilder>

Creates a new `SentinelClientBuilder`

- `sentinels` - Addresses of sentinel nodes
- `service_name` - The name of the service to be queried via the sentinels
- `server_type` - The server type to be queried via the sentinels

Source

#### pub fn build(self) -> RedisResult<SentinelClient>

Creates a new `SentinelClient` from the parameters

Source

#### pub fn set_client_to_redis_tls_mode( self, tls_mode: TlsMode, ) -> SentinelClientBuilder

Set tls mode for the connection to redis

Source

#### pub fn set_client_to_redis_db(self, db: i64) -> SentinelClientBuilder

Set db for the connection to redis

Source

#### pub fn set_client_to_redis_username( self, username: impl AsRef<str>, ) -> SentinelClientBuilder

Set username for the connection to redis

Source

#### pub fn set_client_to_redis_password( self, password: impl AsRef<str>, ) -> SentinelClientBuilder

Set password for the connection to redis

Source

#### pub fn set_client_to_redis_protocol( self, protocol: ProtocolVersion, ) -> SentinelClientBuilder

Set protocol for the connection to redis

Source

#### pub fn set_client_to_redis_certificates( self, certificates: TlsCertificates, ) -> SentinelClientBuilder

Available on crate feature `tls-rustls` only.

Set certificates for the connection to redis

Source

#### pub fn set_client_to_sentinel_tls_mode( self, tls_mode: TlsMode, ) -> SentinelClientBuilder

Set tls mode for the connection to the sentinels

Source

#### pub fn set_client_to_sentinel_username( self, username: impl AsRef<str>, ) -> SentinelClientBuilder

Set username for the connection to the sentinels

Source

#### pub fn set_client_to_sentinel_password( self, password: impl AsRef<str>, ) -> SentinelClientBuilder

Set password for the connection to the sentinels

Source

#### pub fn set_client_to_sentinel_protocol( self, protocol: ProtocolVersion, ) -> SentinelClientBuilder

Set protocol for the connection to the sentinels

Source

#### pub fn set_client_to_sentinel_certificates( self, certificates: TlsCertificates, ) -> SentinelClientBuilder

Available on crate feature `tls-rustls` only.

Set certificate for the connection to the sentinels

## Auto Trait Implementations§

§

### impl Freeze for SentinelClientBuilder

§

### impl RefUnwindSafe for SentinelClientBuilder

§

### impl Send for SentinelClientBuilder

§

### impl Sync for SentinelClientBuilder

§

### impl Unpin for SentinelClientBuilder

§

### impl UnwindSafe for SentinelClientBuilder

## 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.

§

### 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
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.

§

### impl<T> PolicyExt for T
where T: ?Sized,

§

#### fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] only if `self` and `other` return `Action::Follow`. Read more
§

#### fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] if either `self` or `other` returns `Action::Follow`. Read more
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.
§

### 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
§

### impl<T> ErasedDestructor for T
where T: 'static,

§

### impl<T> MaybeSendSync for T