Struct PrivateAuthData 

pub struct PrivateAuthData {
    pub success: bool,
    pub ret_msg: String,
    pub op: String,
    pub conn_id: String,
    pub req_id: Option<String>,
}

Authentication data for private WebSocket streams.

Fields

success: bool

Whether authentication was successful.

true if authentication succeeded, false otherwise. Bots should check this field before proceeding with private stream operations.

ret_msg: String

Return message from authentication.

Typically empty string for success, error message for failure. Bots should log this for debugging authentication issues.

op: String

Operation type, always “auth” for authentication responses.

Bots use this to identify the message type.

conn_id: String

Connection ID for the authenticated WebSocket connection.

A unique identifier for the WebSocket connection. Bots can use this to track specific connections.

req_id: Option<String>

Request ID (optional).

The ID of the authentication request, if provided. Bots can use this to correlate requests and responses.

Implementations

impl PrivateAuthData

pub fn new( success: bool, ret_msg: &str, conn_id: &str, req_id: Option<&str>, ) -> Self

Creates a new PrivateAuthData instance.

pub fn is_success(&self) -> bool

Returns true if authentication was successful.

pub fn is_failure(&self) -> bool

Returns true if authentication failed.

Trait Implementations

impl Clone for PrivateAuthData

fn clone(&self) -> PrivateAuthData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrivateAuthData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PrivateAuthData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PrivateAuthData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.