Sentinel in redis::sentinel - Rust
Description: The Sentinel type, serves as a special purpose client which builds other clients on demand.

Skip to main content

## Sentinel

# Struct Sentinel

Source

    pub struct Sentinel { /* private fields */ }

Available on crate feature `sentinel` only.
Expand description

The Sentinel type, serves as a special purpose client which builds other clients on demand.

## Implementations§

Source§

### impl Sentinel

Source

#### pub fn build<T: IntoConnectionInfo>(params: Vec<T>) -> RedisResult<Sentinel>

Available on crate feature `tls-rustls` only.

Creates a Sentinel client performing some basic checks on the URLs that might make the operation fail.

Source

#### pub fn master_for( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Client>

Determines the master’s address for the given name, and returns a client for that master. This will connect to the master node to verify that it considers itself master so errors can originate from interaction either with Sentinel or with the master node.

Source

#### pub fn get_replica_clients( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Vec<Client>>

Returns Redis `Client` objects for all valid replicas of the given master name. Each client can be used to establish a connection later.

This may return errors originating from either Sentinel or during client construction.

Source

#### pub fn replica_for( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Client>

Connects to a randomly chosen replica of the given master name.

Source

#### pub fn replica_rotate_for( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Client>

Attempts to connect to a different replica of the given master name each time. There is no guarantee that we’ll actually be connecting to a different replica in the next call, but in a static set of replicas (no replicas added or removed), on average we’ll choose each replica the same number of times.

Source§

### impl Sentinel

Source

#### pub async fn async_master_for( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Client>

Determines the master’s address for the given name, and returns a client for that master. This will connect to the master node to verify that it considers itself master so errors can originate from interaction either with Sentinel or with the master node.

Source

#### pub async fn async_get_replica_clients( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Vec<Client>>

Returns Redis `Client` objects for all valid replicas of the given master name. Each client can be used to establish a connection later.

This may return errors originating from either Sentinel or during client construction.

Source

#### pub async fn async_replica_for( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Client>

Connects to a randomly chosen replica of the given master name. Errors can originate from interaction either with Sentinel or with the replica.

Source

#### pub async fn async_replica_rotate_for( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Client>

Attempts to connect to a different replica of the given master name each time. There is no guarantee that we’ll actually be connecting to a different replica in the next call, but in a static set of replicas (no replicas added or removed), on average we’ll choose each replica the same number of times.

## Auto Trait Implementations§

§

### impl Freeze for Sentinel

§

### impl !RefUnwindSafe for Sentinel

§

### impl Send for Sentinel

§

### impl Sync for Sentinel

§

### impl Unpin for Sentinel

§

### impl !UnwindSafe for Sentinel

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