Struct leptos_use::UseEventSourceOptions

pub struct UseEventSourceOptions<T, C>
where
    T: 'static,
    C: StringCodec<T>,
{ /* private fields */ }

Options for use_event_source_with_options.

Implementations

impl<T, C> UseEventSourceOptions<T, C>

where T: 'static, C: StringCodec<T>,

pub fn codec<New__C, New__T>( self, value: New__C ) -> UseEventSourceOptions<New__T, New__C>

where New__T: 'static, New__C: StringCodec<New__T>,

Decodes from the received String to a value of type T.

pub fn reconnect_limit(self, value: u64) -> Self

Retry times. Defaults to 3.

pub fn reconnect_interval(self, value: u64) -> Self

Retry interval in ms. Defaults to 3000.

pub fn on_failed(self, value: impl Fn() + 'static) -> Self

On maximum retry times reached.

pub fn immediate(self, value: bool) -> Self

If true the EventSource connection will immediately be opened when calling this function. If false you have to manually call the open function. Defaults to true.

pub fn named_events(self, value: impl Into<Vec<String>>) -> Self

List of named events to listen for on the EventSource.

pub fn with_credentials(self, value: bool) -> Self

If CORS should be set to include credentials. Defaults to false.

pub fn _marker<New__T>( self, value: PhantomData<New__T> ) -> UseEventSourceOptions<New__T, C>

where New__T: 'static, C: StringCodec<New__T>,

Trait Implementations

impl<T, C: StringCodec<T> + Default> Default for UseEventSourceOptions<T, C>

fn default() -> Self

Returns the “default value” for a type.