pub struct Sse<T> { /* private fields */ }Expand description
A streaming text/event-stream response carrying events of data type T.
Implementations§
Source§impl<T: Serialize + Send + 'static> Sse<T>
impl<T: Serialize + Send + 'static> Sse<T>
Sourcepub fn new<S>(stream: S) -> Self
pub fn new<S>(stream: S) -> Self
Builds an SSE response from a stream of data items.
Each item becomes a data: event; its event name comes from
event (or the #[sse(event = ...)] attribute).
Sourcepub fn events<S>(stream: S) -> Self
pub fn events<S>(stream: S) -> Self
Builds an SSE response from a stream of fully-specified events.
Sourcepub fn event(self, default: impl Into<String>) -> Self
pub fn event(self, default: impl Into<String>) -> Self
Sets the default event name for data items without one.
Sourcepub fn heartbeat(self, every: Duration) -> Self
pub fn heartbeat(self, every: Duration) -> Self
Sets the heartbeat interval (default 15 seconds).
Sourcepub fn no_heartbeat(self) -> Self
pub fn no_heartbeat(self) -> Self
Disables the heartbeat entirely.
Sourcepub fn no_cache(self, on: bool) -> Self
pub fn no_cache(self, on: bool) -> Self
Controls the Cache-Control: no-cache header (default on).
Sourcepub fn disable_proxy_buffering(self, on: bool) -> Self
pub fn disable_proxy_buffering(self, on: bool) -> Self
Controls the X-Accel-Buffering: no header for proxies (default on).
Sourcepub fn max_event_size(self, bytes: usize) -> Self
pub fn max_event_size(self, bytes: usize) -> Self
Drops events whose encoded size exceeds bytes (logged, not sent).
Sourcepub fn client_timeout(self, after: Duration) -> Self
pub fn client_timeout(self, after: Duration) -> Self
Ends the stream after after elapses, regardless of the source.
Sourcepub fn done_event(self, marker: impl Into<String>) -> Self
pub fn done_event(self, marker: impl Into<String>) -> Self
Emits a final raw data: event when the source stream ends.
Trait Implementations§
Source§impl<T> IntoResponse for Sse<T>
impl<T> IntoResponse for Sse<T>
Source§fn into_response(self) -> Response
fn into_response(self) -> Response
self and produces the HTTP response to send to the client.Auto Trait Implementations§
impl<T> !RefUnwindSafe for Sse<T>
impl<T> !Sync for Sse<T>
impl<T> !UnwindSafe for Sse<T>
impl<T> Freeze for Sse<T>
impl<T> Send for Sse<T>
impl<T> Unpin for Sse<T>
impl<T> UnsafeUnpin for Sse<T>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);