Struct RequestBuilder

pub struct RequestBuilder<TReq>
where
    TReq: PayloadSerialize,
{ /* private fields */ }

Builder for Request.

Implementations

impl<TReq> RequestBuilder<TReq>

where TReq: PayloadSerialize + Clone,

pub fn custom_user_data<VALUE: Into<Vec<(String, String)>>>( &mut self, value: VALUE, ) -> &mut Self

User data that will be set as custom MQTT User Properties on the Request message. Can be used to pass additional metadata to the executor. Default is an empty vector.

pub fn topic_tokens<VALUE: Into<HashMap<String, String>>>( &mut self, value: VALUE, ) -> &mut Self

Topic token keys/values to be replaced into the publish topic of the request.

pub fn build(&self) -> Result<Request<TReq>, RequestBuilderError>

Builds a new Request.

Errors

If a required field has not been initialized.

impl<TReq: PayloadSerialize> RequestBuilder<TReq>

pub fn payload(&mut self, payload: TReq) -> Result<&mut Self, AIOProtocolError>

Add a payload to the command request. Validates successful serialization of the payload.

Errors

AIOProtocolError of kind PayloadInvalid if serialization of the payload fails

AIOProtocolError of kind ConfigurationInvalid if the content type is not valid utf-8

pub fn timeout(&mut self, timeout: Duration) -> &mut Self

Set the timeout for the command

Note: Will be rounded up to the nearest second.

Trait Implementations

impl<TReq> Clone for RequestBuilder<TReq>

where TReq: PayloadSerialize + Clone,

fn clone(&self) -> RequestBuilder<TReq>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TReq> Default for RequestBuilder<TReq>

where TReq: PayloadSerialize + Clone,

fn default() -> Self

Returns the “default value” for a type.