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
impl RedisClusterBuilder
Sourcepub fn replicas_per_master(self, n: u16) -> Self
pub fn replicas_per_master(self, n: u16) -> Self
Set the number of replicas per master (default: 0).
Sourcepub fn base_port(self, port: u16) -> Self
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.
Sourcepub fn bind(self, bind: impl Into<String>) -> Self
pub fn bind(self, bind: impl Into<String>) -> Self
Set the bind address for all cluster nodes (default: "127.0.0.1").
Sourcepub fn password(self, password: impl Into<String>) -> Self
pub fn password(self, password: impl Into<String>) -> Self
Set a requirepass password for all cluster nodes.
Sourcepub fn logfile(self, path: impl Into<String>) -> Self
pub fn logfile(self, path: impl Into<String>) -> Self
Set the log file path for all cluster nodes.
Sourcepub fn extra(self, key: impl Into<String>, value: impl Into<String>) -> Self
pub fn extra(self, key: impl Into<String>, value: impl Into<String>) -> Self
Set an arbitrary config directive for all cluster nodes.
Sourcepub fn redis_server_bin(self, bin: impl Into<String>) -> Self
pub fn redis_server_bin(self, bin: impl Into<String>) -> Self
Set a custom redis-server binary path.
Sourcepub fn redis_cli_bin(self, bin: impl Into<String>) -> Self
pub fn redis_cli_bin(self, bin: impl Into<String>) -> Self
Set a custom redis-cli binary path.
Sourcepub async fn start(self) -> Result<RedisClusterHandle>
pub async fn start(self) -> Result<RedisClusterHandle>
Start all nodes and form the cluster.
Auto Trait Implementations§
impl Freeze for RedisClusterBuilder
impl RefUnwindSafe for RedisClusterBuilder
impl Send for RedisClusterBuilder
impl Sync for RedisClusterBuilder
impl Unpin for RedisClusterBuilder
impl UnsafeUnpin for RedisClusterBuilder
impl UnwindSafe for RedisClusterBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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