Struct rants::Connect

pub struct Connect { /* fields omitted */ }

The CONNECT message sent by the client

Methods

impl Connect

pub fn new() -> Self

Construct a new default Connect

pub fn is_verbose(&self) -> bool

Return true if the connection is verbose.

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

Turns on +OK protocol acknowledgements. [default = false]

pub fn is_pedantic(&self) -> bool

Return true if the connection is pedantic.

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

Turns on additional strict format checking, e.g. for properly formed subjects [default = false]

pub fn is_tls_required(&self) -> bool

Return true if the connection requires TLS.

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

Indicates whether the client requires an SSL connection. [default = false]

pub fn authorization(&self) -> Option<&Authorization>

Get the Authorization

pub fn token(&mut self, token: String) -> &mut Self

Set the authorization to use a token

pub fn username_password(
    &mut self,
    username: String,
    password: String
) -> &mut Self

Set the authorization to use a username and password

pub fn set_authorization(
    &mut self,
    authorization: Option<Authorization>
) -> &mut Self

Set the authorization

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

Remove the authorization

pub fn get_name(&self) -> Option<&str>

Get the optional name of the client.

pub fn name(&mut self, name: String) -> &mut Self

Set the optional client name. [default = None]

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

Remove the optional client name [default = None]

pub fn get_lang(&self) -> &str

The implementation language of the client. [always = "rust"]

pub fn get_version(&self) -> &str

The version of the client. [always = "<the crate version>"]

pub fn get_protocol(&self) -> i32

Optional int. Sending 0 (or absent) indicates client supports original protocol. Sending 1 indicates that the client supports dynamic reconfiguration of cluster topology changes by asynchronously receiving INFO messages with known servers it can reconnect to. [always = 1]

pub fn is_echo(&self) -> bool

Return true if echo is enabled on the connection.

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

Optional boolean. If set to true, the server (version 1.2.0+) will send originating messages from this connection to its own subscriptions. Clients should set this to true only for server supporting this feature, which is when proto in the INFO protocol is set to at least 1 [default = false]

Trait Implementations

impl Clone for Connect

fn clone(&self) -> Connect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Connect

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Connect

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<Connect> for Connect

fn eq(&self, other: &Connect) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Connect) -> bool

This method tests for !=.

impl Serialize for Connect

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Connect