Struct ServiceBusMessage

pub struct ServiceBusMessage(/* private fields */);

Represents a Service Bus message output binding.

The following binding attributes are supported:

Name	Description
name	The name of the parameter being bound.
queue_name	The name of the queue. Use only if sending queue messages, not for a topic.
topic_name	The name of the topic. Use only if sending topic messages, not for a queue.
subscription_name	The name of the subscription. Use only if sending topic messages, not for a queue.
connection	The name of an app setting that contains the Service Bus connection string to use for this binding. Defaults to AzureWebJobsServiceBus.

Examples

An example that creates a Service Bus queue message based on a HTTP trigger:

use azure_functions::{
    bindings::{HttpRequest, ServiceBusMessage},
    func,
};

#[func]
#[binding(name = "$return", queue_name = "example", connection = "connection")]
pub fn create_queue_message(req: HttpRequest) -> ServiceBusMessage {
    format!(
        "Hello from Rust, {}!\n",
        req.query_params().get("name").map_or("stranger", |x| x)
    )
    .into()
}

An example that creates a Service Bus topic message based on a HTTP trigger:

use azure_functions::{
    bindings::{HttpRequest, ServiceBusMessage},
    func,
};

#[func]
#[binding(
    name = "$return",
    topic_name = "mytopic",
    subscription_name = "mysubscription",
    connection = "connection"
)]
pub fn create_topic_message(req: HttpRequest) -> ServiceBusMessage {
    format!(
        "Hello from Rust, {}!\n",
        req.query_params().get("name").map_or("stranger", |x| x)
    )
    .into()
}

Implementations

impl ServiceBusMessage

pub fn as_str(&self) -> Option<&str>

Gets the content of the message as a string.

Returns None if there is no valid string representation of the message.

pub fn as_bytes(&self) -> &[u8]

Gets the content of the message as a slice of bytes.

pub fn as_json<'b, T>(&'b self) -> Result<T>

where T: Deserialize<'b>,

Deserializes the message as JSON to the requested type.

Trait Implementations

impl Clone for ServiceBusMessage

fn clone(&self) -> ServiceBusMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceBusMessage

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

Formats the value using the given formatter.

impl Display for ServiceBusMessage

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

Formats the value using the given formatter.

impl<'a> From<&'a [u8]> for ServiceBusMessage

fn from(content: &'a [u8]) -> Self

Converts to this type from the input type.

impl From<&Value> for ServiceBusMessage

fn from(content: &Value) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for ServiceBusMessage

fn from(content: &'a str) -> Self

Converts to this type from the input type.

impl From<String> for ServiceBusMessage

fn from(content: String) -> Self

Converts to this type from the input type.

impl From<Value> for ServiceBusMessage

fn from(content: Value) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for ServiceBusMessage

fn from(content: Vec<u8>) -> Self

Converts to this type from the input type.

impl<'a> Into<Body<'a>> for ServiceBusMessage

fn into(self) -> Body<'a>

Converts this type into the (usually inferred) input type.

impl Into<String> for ServiceBusMessage

fn into(self) -> String

Converts this type into the (usually inferred) input type.

impl Into<Value> for ServiceBusMessage

fn into(self) -> Value

Converts this type into the (usually inferred) input type.

impl Into<Vec<u8>> for ServiceBusMessage

fn into(self) -> Vec<u8>

Converts this type into the (usually inferred) input type.