Struct paho_mqtt::server_response::ServerResponse

pub struct ServerResponse { /* private fields */ }

Responses coming back from the server from client requests.

Implementations

impl ServerResponse

pub fn new() -> Self

Creates a new, empty, server response.

pub unsafe fn from_success(
    req: ServerRequest,
    rsp: &MQTTAsync_successData
) -> Self

Creates the response object from the v3 “success” data structure sent by the C lib on completion of the operation.

Safety

This function runs in the context of a C callback indicating a successful action. It directly accesses the pointers and unions in the C MQTTAsync_successData struct.

pub unsafe fn from_success5(
    req: ServerRequest,
    rsp: &MQTTAsync_successData5
) -> Self

Creates the response object from the v5 “success” data structure sent by the C lib on completion of the operation.

Safety

This function runs in the context of a C callback indicating a successful v5 action. It directly accesses the pointers and unions in the C MQTTAsync_successData5 struct.

pub unsafe fn from_failure5(rsp: &MQTTAsync_failureData5) -> Self

Creates the response object from the v5 “failure” data structure sent by the C lib on completion of the operation.

Safety

This function runs in the context of a C callback indicating a failed v5 action. It directly accesses the pointers and unions in the C MQTTAsync_failureData5 struct.

pub fn request_response(&self) -> &RequestResponse

Gets the response for the specific type of request.

pub fn connect_response(&self) -> Option<ConnectResponse>

Gets the response for a connection request

pub fn subscribe_response(&self) -> Option<i32>

Gets the response for a subscription request.

pub fn subscribe_many_response(&self) -> Option<Vec<i32>>

Gets the response for a multi-topic subscription request.

pub fn unsubscribe_response(&self) -> Option<i32>

Gets the response for an unsubscribe request.

pub fn unsubscribe_many_response(&self) -> Option<Vec<i32>>

Gets the response for a multi-topic unsubscribe request.

pub fn properties(&self) -> &Properties

Gets the properties returned from the server.

pub fn reason_code(&self) -> ReasonCode

Gets the reason code returned from the server.

Trait Implementations

impl Clone for ServerResponse

fn clone(&self) -> ServerResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServerResponse

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

Formats the value using the given formatter.

impl Default for ServerResponse

fn default() -> ServerResponse

Returns the “default value” for a type.