Enum SecurityMechanism 

#[non_exhaustive]
#[repr(i32)]
pub enum SecurityMechanism {
    Null,
    Plain {
        username: String,
        password: String,
    },
    CurveClient {
        server_key: Vec<u8>,
        public_key: Vec<u8>,
        secret_key: Vec<u8>,
    },
    CurveServer {
        secret_key: Vec<u8>,
    },
    GssApiClient {
        service_principal: String,
    },
    GssApiServer,
}

0MQ security mechanisms

A 0MQ socket can select a security mechanism. Both peers must use the same security mechanism.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Null

Null security

Plain

Plain-textauthentication using username and password

Fields

username: String

password: String

CurveClient

Available on zmq_has=curve only.

Elliptic curve client authentication and encryption

Fields

server_key: Vec<u8>

public_key: Vec<u8>

secret_key: Vec<u8>

CurveServer

Available on zmq_has=curve only.

Elliptic curve server authentication and encryption

Fields

secret_key: Vec<u8>

GssApiClient

Available on zmq_has=gssapi only.

GSSAPI client authentication and encryption

Fields

service_principal: String

GssApiServer

Available on zmq_has=gssapi only.

GSSAPI server authentication and encryption

Implementations

impl SecurityMechanism

pub fn apply<T: SocketType>(&self, socket: &Socket<T>) -> ZmqResult<()>

Applies the security mechanism to the provided socket

Examples found in repository

src/socket/mod.rs (line 2478)

    pub fn set_security_mechanism(&self, security: &SecurityMechanism) -> ZmqResult<()> {
        security.apply(self)
    }

Trait Implementations

impl Clone for SecurityMechanism

fn clone(&self) -> SecurityMechanism

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecurityMechanism

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

Formats the value using the given formatter.

impl Default for SecurityMechanism

fn default() -> SecurityMechanism

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SecurityMechanism

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecurityMechanism

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

Formats the value using the given formatter.

impl Eq for SecurityMechanism

impl Hash for SecurityMechanism

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SecurityMechanism

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SecurityMechanism

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 SecurityMechanism

impl<T: SocketType> TryFrom<&Socket<T>> for SecurityMechanism

type Error = ZmqError

The type returned in the event of a conversion error.

fn try_from(socket: &Socket<T>) -> Result<Self, Self::Error>

Performs the conversion.