Struct Identifier 

pub struct Identifier { /* private fields */ }

Names one subscription: a channel and the params that go with it, like the id of the record the channel streams for.

The server treats the identifier’s JSON encoding as an opaque key and echoes it back on every frame it sends for the subscription, so the encoding has to be stable: the keys come out sorted, channel among them.

use actioncable::Identifier;

let room = Identifier::new("RoomChannel").param("id", 42);
assert_eq!(r#"{"channel":"RoomChannel","id":42}"#, room.key());

A channel with no params needs only the name.

Implementations

impl Identifier

pub fn new(channel: impl Into<String>) -> Identifier

Names a channel, with no params.

pub fn param( self, name: impl Into<String>, value: impl Into<Value>, ) -> Identifier

Adds one param, like the id of the record the channel streams for.

pub fn channel(&self) -> &str

The channel’s name.

pub fn params(&self) -> &BTreeMap<String, Value>

The params, sorted by name as the key encodes them.

pub fn key(&self) -> String

The JSON string the server knows the subscription by. A param named channel loses to the channel name.

Where the Go client returns an error, this cannot fail: a param is a serde_json::Value, and a map of them always encodes.

Trait Implementations

impl Clone for Identifier

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Identifier

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

Formats the value using the given formatter.

impl Display for Identifier

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

Formats the value using the given formatter.

impl Eq for Identifier

impl From<Identifier> for SubscribeRequest

fn from(identifier: Identifier) -> SubscribeRequest

Converts to this type from the input type.

impl PartialEq for Identifier

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Identifier