Struct gloo_net::eventsource::futures::EventSource

pub struct EventSource { /* private fields */ }

Available on crate feature eventsource only.

Wrapper around browser’s EventSource API. Dropping this will close the underlying event source.

Implementations

impl EventSource

pub fn new(url: &str) -> Result<Self, JsError>

Establish an EventSource.

This function may error in the following cases:

• The connection url is invalid

The error returned is JsError. See the MDN Documentation to learn more.

pub fn subscribe(
    &mut self,
    event_type: impl Into<String>
) -> Result<EventSourceSubscription, JsError>

Subscribes to listening for a specific type of event.

All events for this type are streamed back given the subscription returned.

The event type of “message” is a special case, as it will capture events without an event field as well as events that have the specific type event: message. It will not trigger on any other event type.

pub fn close(self)

Closes the EventSource.

See the MDN Documentation to learn about this function

pub fn state(&self) -> State

The current state of the EventSource.

Trait Implementations

impl Clone for EventSource

fn clone(&self) -> EventSource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventSource

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

Formats the value using the given formatter.

impl Drop for EventSource

fn drop(&mut self)

Executes the destructor for this type.