Struct WebsocketHeartbeat 

pub struct WebsocketHeartbeat {
    pub interval_secs: i32,
    pub message: String,
    pub state_field: Option<String>,
}

Fields

interval_secs: i32

Interval in seconds between heartbeat messages

message: String

Message to send as heartbeat. Use {{state}} as a placeholder for a value extracted from incoming messages (see state_field).

state_field: Option<String>

Optional. Top-level JSON field to extract from incoming messages. The extracted value replaces {{state}} in the heartbeat message.

Implementations

impl WebsocketHeartbeat

pub fn new(interval_secs: i32, message: String) -> WebsocketHeartbeat

Trait Implementations

impl Clone for WebsocketHeartbeat

fn clone(&self) -> WebsocketHeartbeat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebsocketHeartbeat

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

Formats the value using the given formatter.

impl Default for WebsocketHeartbeat

fn default() -> WebsocketHeartbeat

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebsocketHeartbeat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WebsocketHeartbeat

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for WebsocketHeartbeat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WebsocketHeartbeat