Struct HttpWebSocketResponse 

pub struct HttpWebSocketResponse {
    pub subprotocol: Option<String>,
    pub messages: Option<Vec<WebSocketMessage>>,
    pub matchers: Option<Vec<WebSocketMatcher>>,
    pub close_connection: Option<bool>,
    pub delay: Option<Delay>,
    pub template_type: Option<String>,
    pub graphql_subscription_filter: Option<GraphqlSubscriptionFilter>,
    pub primary: Option<bool>,
    pub extra: Extra,
}

Builder for a WebSocket streaming response action.

Serialized as the httpWebSocketResponse action in an expectation.

Example

use mockserver_client::{HttpWebSocketResponse, WebSocketMessage};

let ws = HttpWebSocketResponse::new()
    .subprotocol("chat")
    .message(WebSocketMessage::text("hello"))
    .message(WebSocketMessage::binary([0x01, 0x02]))
    .close_connection(true);

Fields

subprotocol: Option<String>

messages: Option<Vec<WebSocketMessage>>

matchers: Option<Vec<WebSocketMatcher>>

Per-incoming-frame response rules; when set, an incoming frame matching a rule triggers that rule’s responses.

close_connection: Option<bool>

delay: Option<Delay>

template_type: Option<String>

graphql_subscription_filter: Option<GraphqlSubscriptionFilter>

GraphQL subscription query filter for the graphql-transport-ws protocol.

primary: Option<bool>

extra: Extra

Catch-all for server fields this client does not model yet, so a retrieve -> re-submit cycle cannot silently destroy them.

Implementations

impl HttpWebSocketResponse

pub fn new() -> Self

Create a new empty WebSocket response.

pub fn matcher(self, matcher: WebSocketMatcher) -> Self

Append an incoming-frame matcher rule.

pub fn matchers(self, matchers: Vec<WebSocketMatcher>) -> Self

Replace all incoming-frame matcher rules.

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

Set the negotiated subprotocol.

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

Append a WebSocket message to send.

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

Replace all WebSocket messages.

pub fn close_connection(self, close: bool) -> Self

Whether to close the connection after emitting all messages.

pub fn delay(self, delay: Delay) -> Self

Set a delay before the response starts.

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

Set the template type (VELOCITY, JAVASCRIPT or MUSTACHE).

pub fn graphql_subscription_filter( self, filter: GraphqlSubscriptionFilter, ) -> Self

Set the GraphQL subscription filter.

pub fn primary(self, primary: bool) -> Self

Mark this action as the primary action of the expectation.

Trait Implementations

impl Clone for HttpWebSocketResponse

fn clone(&self) -> HttpWebSocketResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpWebSocketResponse

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

Formats the value using the given formatter.

impl Default for HttpWebSocketResponse

fn default() -> HttpWebSocketResponse

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HttpWebSocketResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HttpWebSocketResponse

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for HttpWebSocketResponse

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 HttpWebSocketResponse