Struct SignalRConnectionInfo

pub struct SignalRConnectionInfo {
    pub url: String,
    pub access_token: String,
}

Represents the SignalR connection information input binding.

The following binding attributes are supported:

Name	Description
name	The name of the parameter being bound.
hub_name	The name of the SignalR hub for which the connection information is generated.
user_id	The value of the user identifier claim to be set in the access key token (optional).
connection	The name of the app setting that contains the SignalR Service connection string. Defaults to AzureSignalRConnectionString.

Examples

This example implements an HTTP-triggered Azure Function that returns SignalR connection information:

use azure_functions::{
    bindings::{HttpRequest, HttpResponse, SignalRConnectionInfo},
    func,
};

#[func]
#[binding(name = "_req", auth_level = "anonymous")]
#[binding(
    name = "info",
    hub_name = "chat",
    user_id = "{headers.x-ms-signalr-userid}",
    connection = "myconnection"
)]
pub fn negotiate(_req: HttpRequest, info: SignalRConnectionInfo) -> HttpResponse {
    info.into()
}

Fields

url: String

The endpoint URL for the SignalR service.

access_token: String

The access token for the SignalR service.

Trait Implementations

impl Clone for SignalRConnectionInfo

fn clone(&self) -> SignalRConnectionInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SignalRConnectionInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SignalRConnectionInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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

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

impl Serialize for SignalRConnectionInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.