Skip to main content

RedisClusterBuilder

Struct RedisClusterBuilder 

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

Builder for a Redis Cluster.

§Example

use redis_server_wrapper::RedisCluster;

let cluster = RedisCluster::builder()
    .masters(3)
    .replicas_per_master(1)
    .base_port(7000)
    .start()
    .await
    .unwrap();

assert!(cluster.is_healthy().await);
// Stopped automatically on Drop.

Implementations§

Source§

impl RedisClusterBuilder

Source

pub fn masters(self, n: u16) -> Self

Set the number of master nodes (default: 3).

Source

pub fn replicas_per_master(self, n: u16) -> Self

Set the number of replicas per master (default: 0).

Source

pub fn base_port(self, port: u16) -> Self

Set the base port for cluster nodes (default: 7000).

Nodes are assigned consecutive ports starting at this value.

Source

pub fn bind(self, bind: impl Into<String>) -> Self

Set the bind address for all cluster nodes (default: "127.0.0.1").

Source

pub fn password(self, password: impl Into<String>) -> Self

Set a requirepass password for all cluster nodes.

Source

pub fn logfile(self, path: impl Into<String>) -> Self

Set the log file path for all cluster nodes.

Source

pub fn extra(self, key: impl Into<String>, value: impl Into<String>) -> Self

Set an arbitrary config directive for all cluster nodes.

Source

pub fn redis_server_bin(self, bin: impl Into<String>) -> Self

Set a custom redis-server binary path.

Source

pub fn redis_cli_bin(self, bin: impl Into<String>) -> Self

Set a custom redis-cli binary path.

Source

pub async fn start(self) -> Result<RedisClusterHandle>

Start all nodes and form the cluster.

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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.