Struct QueueMessage

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

Represents an Azure Storage Queue 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.
connection	The name of an app setting that contains the Azure Storage connection string to use for this binding. Defaults to the AzureWebJobsStorage.

Examples

Creating a queue message from a string:

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

#[func]
#[binding(name = "output1", queue_name = "example")]
pub fn example(_req: HttpRequest) -> ((), QueueMessage) {
    ((), "Hello world!".into())
}

Creating a queue message from a JSON value (see the json! macro from the serde_json crate):

use azure_functions::bindings::{HttpRequest, QueueMessage};
use azure_functions::func;
use serde_json::json;

#[func]
#[binding(name = "output1", queue_name = "example")]
pub fn example(_req: HttpRequest) -> ((), QueueMessage) {
    ((), json!({ "hello": "world" }).into())
}

Creating a queue message from a sequence of bytes:

use azure_functions::bindings::{HttpRequest, QueueMessage};
use azure_functions::func;
use serde_json::json;

#[func]
#[binding(name = "output1", queue_name = "example")]
pub fn example(_req: HttpRequest) -> ((), QueueMessage) {
    ((), [1, 2, 3][..].into())
}

Implementations

impl QueueMessage

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 QueueMessage

fn clone(&self) -> QueueMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueueMessage

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

Formats the value using the given formatter.

impl Display for QueueMessage

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<&Value> for QueueMessage

fn from(content: &Value) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<String> for QueueMessage

fn from(content: String) -> Self

Converts to this type from the input type.

impl From<Value> for QueueMessage

fn from(content: Value) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for QueueMessage

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

Converts to this type from the input type.

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

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

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

impl Into<String> for QueueMessage

fn into(self) -> String

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

impl Into<Value> for QueueMessage

fn into(self) -> Value

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

impl Into<Vec<u8>> for QueueMessage

fn into(self) -> Vec<u8>

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