Struct SseSender

Source

pub struct SseSender { /* private fields */ }

Expand description

Sends events to one streaming SSE response; clone it to send from several places. The stream ends when the last clone is dropped.

Implementations§

Source §

impl SseSender

Source

pub fn send(&self, event: SseEvent) -> Result<(), SseClosed>

Send event, waiting while the buffer is full (a slow client slows the sender down rather than growing memory). Blocks the thread: in async code use Self::send_async or Self::try_send.

Source

pub fn try_send(&self, event: SseEvent) -> Result<bool, SseClosed>

Send event if there’s room: Ok(false) when the buffer is full and the event was dropped.

Source

pub async fn send_async(&self, event: SseEvent) -> Result<(), SseClosed>

Available on crate feature http2 only.

Self::send without blocking the async runtime: waits for room with short sleeps.

Source

pub fn data(&self, data: &str) -> Result<(), SseClosed>

Send a data-only event (the client’s message event).

Source

pub fn comment(&self, text: &str) -> Result<(), SseClosed>

Send a comment line (ignored by clients).

Trait Implementations§

Source §

impl Clone for SseSender

Source §

fn clone(&self) -> SseSender

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl UnwindSafe for SseSender

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §