Struct Connector

pub struct Connector { /* private fields */ }

A builder for Client with more options than Client::connect.

Uses Client::connector to construct one.

Implementations

impl Connector

pub fn with_session_timeout(self, timeout: Duration) -> Self

Specifies target session timeout to negotiate with ZooKeeper server.

Defaults to 6s.

pub fn session_timeout(&mut self, timeout: Duration) -> &mut Self

👎Deprecated since 0.11.0: use Connector::with_session_timeout instead

Specifies target session timeout to negotiate with ZooKeeper server.

Defaults to 6s.

pub fn with_connection_timeout(self, timeout: Duration) -> Self

Specifies idle timeout to conclude a connection as loss.

Defaults to 2/5 of session timeout.

pub fn connection_timeout(&mut self, timeout: Duration) -> &mut Self

👎Deprecated since 0.11.0: use Connector::with_connection_timeout instead

Specifies idle timeout to conclude a connection as loss.

Defaults to 2/5 of session timeout.

pub fn with_readonly(self, readonly: bool) -> Self

Specifies whether readonly session is allowed.

pub fn readonly(&mut self, readonly: bool) -> &mut Self

👎Deprecated since 0.11.0: use Connector::with_readonly instead

Specifies whether readonly session is allowed.

pub fn with_auth(self, scheme: &str, auth: &[u8]) -> Self

Adds auth info for given authentication scheme.

pub fn auth(&mut self, scheme: String, auth: Vec<u8>) -> &mut Self

👎Deprecated since 0.11.0: use Connector::with_auth instead

Specifies auth info for given authentication scheme.

pub fn with_session(self, session: SessionInfo) -> Self

Specifies session to reestablish.

pub fn session(&mut self, session: SessionInfo) -> &mut Self

👎Deprecated since 0.11.0: use Connector::with_session instead

Specifies session to reestablish.

pub fn with_server_version(self, major: u32, minor: u32, patch: u32) -> Self

Specifies target server version of ZooKeeper cluster.

Client will issue server compatible protocol to avoid Error::Unimplemented for some operations. See Client::create for an example.

See ZOOKEEPER-1381 and ZOOKEEPER-3762 for references.

pub fn server_version( &mut self, major: u32, minor: u32, patch: u32, ) -> &mut Self

👎Deprecated since 0.11.0: use Connector::with_server_version instead

Specifies target server version of ZooKeeper cluster.

Client will issue server compatible protocol to avoid Error::Unimplemented for some operations. See Client::create for an example.

See ZOOKEEPER-1381 and ZOOKEEPER-3762 for references.

pub fn with_detached(self) -> Self

Detaches created session so it will not be closed after all client instances dropped.

pub fn detached(&mut self) -> &mut Self

👎Deprecated since 0.11.0: use Connector::with_detached instead

Detaches created session so it will not be closed after all client instances dropped.

pub fn with_tls(self, options: TlsOptions) -> Self

Available on crate feature tls only.

Specifies tls options for connections to ZooKeeper.

pub fn tls(&mut self, options: TlsOptions) -> &mut Self

👎Deprecated since 0.11.0: use Connector::with_tls instead

Available on crate feature tls only.

Specifies tls options for connections to ZooKeeper.

pub fn with_sasl(self, options: impl Into<SaslOptions>) -> Self

Available on crate features sasl or sasl-gssapi or sasl-digest-md5 only.

Specifies SASL options.

pub fn sasl(&mut self, options: impl Into<SaslOptions>) -> &mut Self

👎Deprecated since 0.11.0: use Connector::with_sasl instead

Available on crate features sasl or sasl-gssapi or sasl-digest-md5 only.

Specifies SASL options.

pub fn with_fail_eagerly(self) -> Self

Fail session establishment eagerly with Error::NoHosts when all hosts has been tried.

This permits fail-fast without wait up to Self::session_timeout in Self::connect. This is not suitable for situations where ZooKeeper cluster is accessible via a single virtual IP.

pub fn fail_eagerly(&mut self) -> &mut Self

👎Deprecated since 0.11.0: use Connector::with_fail_eagerly instead

Fail session establishment eagerly with Error::NoHosts when all hosts has been tried.

This permits fail-fast without wait up to Self::session_timeout in Self::connect. This is not suitable for situations where ZooKeeper cluster is accessible via a single virtual IP.

pub async fn secure_connect(self, cluster: &str) -> Result<Client, Error>

Connects to ZooKeeper cluster.

Same to Self::connect except that server1 will use tls encrypted protocol given the connection string server1,tcp://server2,tcp+tls://server3.

pub async fn connect(self, cluster: &str) -> Result<Client, Error>

Connects to ZooKeeper cluster.

Parameter cluster specifies connection string to ZooKeeper cluster. It has same syntax as Java client except that you can specifies protocol for server individually. For example, server1,tcp://server2,tcp+tls://server3. This claims that server1 and server2 use plaintext protocol, while server3 uses tls encrypted protocol.

Notable errors

• Error::NoHosts if no host is available and Self::fail_eagerly is turn on
• Error::SessionExpired if specified session expired
• Error::Timeout if no session established with in approximate Self::session_timeout

Trait Implementations

impl Clone for Connector

fn clone(&self) -> Connector

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Connector

fn fmt(&self, __f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.