Connect

Struct Connect 

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

The CONNECT message sent by the client

Implementations§

Source§

impl Connect

Source

pub fn new() -> Self

Construct a new default Connect

Source

pub fn is_verbose(&self) -> bool

Return true if the connection is verbose.

Source

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

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

Source

pub fn is_pedantic(&self) -> bool

Return true if the connection is pedantic.

Source

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

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

Source

pub fn is_tls_required(&self) -> bool

Return true if the connection requires TLS.

Source

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

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

Source

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

Get the Authorization

Source

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

Set the authorization to use a token

Source

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

Set the authorization to use a username and password

Source

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

Set the authorization

Source

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

Remove the authorization

Source

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

Get the optional name of the client.

Source

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

Set the optional client name. [default = None]

Source

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

Remove the optional client name [default = None]

Source

pub fn get_lang(&self) -> &str

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

Source

pub fn get_version(&self) -> &str

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

Source

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]

Source

pub fn is_echo(&self) -> bool

Return true if echo is enabled on the connection.

Source

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§

Source§

impl Clone for Connect

Source§

fn clone(&self) -> Connect

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Connect

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Connect

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Connect

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Connect

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Connect

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> Erased for T