Struct EventHubMessage

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

Represents an Event Hubs message output binding.

The following binding attributes are supported:

Name	Description
name	The name of the parameter being bound.
event_hub_name	The name of the event hub. When the event hub name is also present in the connection string, that value overrides this property at runtime.
connection	The name of an app setting that contains the connection string to the event hub’s namespace. This connection string must have send permissions to send the message to the event stream.

Examples

Creating a message from a string:

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

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

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

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

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

Creating a message from a sequence of bytes:

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

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

Implementations

impl EventHubMessage

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 EventHubMessage

fn clone(&self) -> EventHubMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventHubMessage

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

Formats the value using the given formatter.

impl Display for EventHubMessage

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<&Value> for EventHubMessage

fn from(content: &Value) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<String> for EventHubMessage

fn from(content: String) -> Self

Converts to this type from the input type.

impl From<Value> for EventHubMessage

fn from(content: Value) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for EventHubMessage

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

Converts to this type from the input type.

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

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

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

impl Into<String> for EventHubMessage

fn into(self) -> String

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

impl Into<Value> for EventHubMessage

fn into(self) -> Value

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

impl Into<Vec<u8>> for EventHubMessage

fn into(self) -> Vec<u8>

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