Struct HttpSseResponse 

pub struct HttpSseResponse {
    pub status_code: Option<u16>,
    pub headers: Option<HashMap<String, Vec<String>>>,
    pub events: Option<Vec<SseEvent>>,
    pub close_connection: Option<bool>,
    pub delay: Option<Delay>,
    pub template_type: Option<String>,
    pub primary: Option<bool>,
    pub extra: Extra,
}

Builder for a Server-Sent Events (SSE) streaming response action.

Serialized as the httpSseResponse action in an expectation.

Example

use mockserver_client::{HttpSseResponse, SseEvent};

let sse = HttpSseResponse::new()
    .status_code(200)
    .header("Content-Type", "text/event-stream")
    .event(SseEvent::new().event("message").data("hello").id("1"))
    .close_connection(true);

Fields

status_code: Option<u16>

headers: Option<HashMap<String, Vec<String>>>

events: Option<Vec<SseEvent>>

close_connection: Option<bool>

delay: Option<Delay>

template_type: Option<String>

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 HttpSseResponse

pub fn new() -> Self

Create a new empty SSE response.

pub fn status_code(self, code: u16) -> Self

Set the HTTP status code.

pub fn header(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add a response header.

pub fn event(self, event: SseEvent) -> Self

Append an SSE event to the stream.

pub fn events(self, events: Vec<SseEvent>) -> Self

Replace all SSE events.

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

Whether to close the connection after emitting all events.

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 primary(self, primary: bool) -> Self

Mark this action as the primary action of the expectation.

Trait Implementations

impl Clone for HttpSseResponse

fn clone(&self) -> HttpSseResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpSseResponse

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

Formats the value using the given formatter.

impl Default for HttpSseResponse

fn default() -> HttpSseResponse

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HttpSseResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HttpSseResponse

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for HttpSseResponse

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 HttpSseResponse