Struct BasicProperties 

pub struct BasicProperties { /* private fields */ }

AMQP message properties.

User is recommended to use the chainable setter to create desired propertities.

See also message properties.

Example

let basic_props = BasicProperties::default()
    .with_content_type("application/json")
    .with_persistence(true)
    .with_message_type("app1.notifications.orders.created")
    .with_app_id("app1")
    .finish();

Implementations

impl BasicProperties

pub fn new( content_type: Option<String>, content_encoding: Option<String>, headers: Option<FieldTable>, delivery_mode: Option<u8>, priority: Option<u8>, correlation_id: Option<String>, reply_to: Option<String>, expiration: Option<String>, message_id: Option<String>, timestamp: Option<u64>, message_type: Option<String>, user_id: Option<String>, app_id: Option<String>, cluster_id: Option<String>, ) -> BasicProperties

Returns a new instance.

pub fn content_type(&self) -> Option<&String>

pub fn with_content_type(&mut self, content_type: &str) -> &mut BasicProperties

Chainable setter of content type.

Default: None

pub fn content_encoding(&self) -> Option<&String>

pub fn with_content_encoding( &mut self, content_encoding: &str, ) -> &mut BasicProperties

Chainable setter of content encoding.

Default: None

pub fn headers(&self) -> Option<&FieldTable>

pub fn with_headers(&mut self, headers: FieldTable) -> &mut BasicProperties

Chainable setter of headers.

Default: None

pub fn delivery_mode(&self) -> Option<u8>

pub fn with_delivery_mode(&mut self, delivery_mode: u8) -> &mut BasicProperties

Chainable setter of delivery mode. Prefer with_persistence as it is more to the point.

delivery_mode: either DELIVERY_MODE_TRANSIENT or DELIVERY_MODE_PERSISTENT

Default: None

Example

let basic_props = BasicProperties::default()
    .with_content_type("application/json")
    .with_delivery_mode(DELIVERY_MODE_PERSISTENT)
    .finish();

pub fn with_persistence(&mut self, persistent: bool) -> &mut BasicProperties

Marks a message as persistent (or not) using a boolean. When in doubt, prefer publishing messages as persistent.

persistent: true for persistent delivery mode (2), false for transient (1) with_persistence(true) is equivalent to with_delivery_mode(DELIVERY_MODE_PERSISTENT). with_persistence(false) is equivalent to with_delivery_mode(DELIVERY_MODE_TRANSIENT).

Example

use amqprs::BasicProperties;
use amqprs::{DELIVERY_MODE_PERSISTENT, DELIVERY_MODE_TRANSIENT};
let mut prop1 = BasicProperties::default()
    .with_persistence(true)
    .finish();
let mut prop2 = BasicProperties::default()
    .with_delivery_mode(DELIVERY_MODE_PERSISTENT)
    .finish();
assert_eq!(prop1.delivery_mode(), prop2.delivery_mode());
prop1.with_persistence(false);
prop2.with_delivery_mode(DELIVERY_MODE_TRANSIENT);
assert_eq!(prop1.delivery_mode(), prop2.delivery_mode());

pub fn priority(&self) -> Option<u8>

pub fn with_priority(&mut self, priority: u8) -> &mut BasicProperties

Chainable setter of priority.

priority: message priority, 0 to 9

Default: None

pub fn correlation_id(&self) -> Option<&String>

pub fn with_correlation_id( &mut self, correlation_id: &str, ) -> &mut BasicProperties

Chainable setter of correlation id.

correlation_id: application correlation identifier

Default: None

pub fn reply_to(&self) -> Option<&String>

pub fn with_reply_to(&mut self, reply_to: &str) -> &mut BasicProperties

Chainable setter of reply_to.

Default: None

pub fn expiration(&self) -> Option<&String>

pub fn with_expiration(&mut self, expiration: &str) -> &mut BasicProperties

Chainable setter of expiration.

Default: None

pub fn message_id(&self) -> Option<&String>

pub fn with_message_id(&mut self, message_id: &str) -> &mut BasicProperties

Chainable setter of message_id.

Default: None

pub fn timestamp(&self) -> Option<u64>

pub fn with_timestamp(&mut self, timestamp: u64) -> &mut BasicProperties

Chainable setter of timestamp.

Default: None

pub fn message_type(&self) -> Option<&String>

pub fn with_message_type(&mut self, message_type: &str) -> &mut BasicProperties

Chainable setter of message_type.

Default: None

pub fn user_id(&self) -> Option<&String>

pub fn with_user_id(&mut self, user_id: &str) -> &mut BasicProperties

Chainable setter of user_id.

Default: None

pub fn app_id(&self) -> Option<&String>

pub fn with_app_id(&mut self, app_id: &str) -> &mut BasicProperties

Chainable setter of app_id.

Default: None

pub fn cluster_id(&self) -> Option<&String>

pub fn with_cluster_id(&mut self, cluster_id: &str) -> &mut BasicProperties

Chainable setter of cluster_id.

Default: None

pub fn finish(&mut self) -> BasicProperties

Finish chaining and returns a new instance according to chained configurations.

Trait Implementations

impl Clone for BasicProperties

fn clone(&self) -> BasicProperties

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BasicProperties

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

Formats the value using the given formatter.

impl Default for BasicProperties

fn default() -> BasicProperties

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BasicProperties

fn deserialize<D>( deserializer: D, ) -> Result<BasicProperties, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BasicProperties

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

Formats the value using the given formatter.

impl Serialize for BasicProperties

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

where __S: Serializer,

Serialize this value into the given Serde serializer.