Struct WebSocketMatcher 

pub struct WebSocketMatcher {
    pub frame_type: Option<String>,
    pub text_matcher: Option<String>,
    pub responses: Option<Vec<WebSocketMessage>>,
    pub extra: Extra,
}

A per-incoming-frame response rule inside an HttpWebSocketResponse::matchers.

When an incoming WebSocket frame matches this rule (by frame_type and/or text_matcher), the paired responses are sent back. Unknown fields are captured in extra so the shape round-trips without loss.

Fields

frame_type: Option<String>

Frame type to match: "TEXT", "BINARY", "PING", "PONG" or "ANY".

text_matcher: Option<String>

Exact-or-regex matcher applied to a text frame’s payload.

responses: Option<Vec<WebSocketMessage>>

Messages sent in reply when an incoming frame matches this rule.

extra: Extra

Forward-compatibility catch-all for matcher fields not yet named.

Implementations

impl WebSocketMatcher

pub fn new() -> Self

Create a new empty matcher rule.

pub fn frame_type(self, frame_type: impl Into<String>) -> Self

Set the frame type to match ("TEXT", "BINARY", "PING", "PONG", "ANY").

pub fn text_matcher(self, text_matcher: impl Into<String>) -> Self

Set an exact-or-regex matcher for a text frame’s payload.

pub fn response(self, response: WebSocketMessage) -> Self

Append a reply message sent when an incoming frame matches this rule.

pub fn responses(self, responses: Vec<WebSocketMessage>) -> Self

Replace all reply messages.

Trait Implementations

impl Clone for WebSocketMatcher

fn clone(&self) -> WebSocketMatcher

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketMatcher

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

Formats the value using the given formatter.

impl Default for WebSocketMatcher

fn default() -> WebSocketMatcher

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebSocketMatcher

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WebSocketMatcher

fn eq(&self, other: &WebSocketMatcher) -> 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 WebSocketMatcher

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 WebSocketMatcher