ssevents - v0.3.0

ssevents/event

Event and item domain values.

Event is opaque so the package can evolve its representation without a breaking change. Construct via new, from_parts, and the builder helpers. Item stays transparent because callers and helper modules frequently pattern match on whether a stream element is an event or a comment.

Types

Event

opaque </> 
pub opaque type Event

Item

</> 
pub type Item {
  EventItem(Event)
  Comment(String)
}

Constructors 

  • EventItem(Event)
  • Comment(String)

Values

data

</> 
pub fn data(event: Event, data: String) -> Event

data_of

</> 
pub fn data_of(event: Event) -> String

event

</> 
pub fn event(event: Event, name: String) -> Event

event_item

</> 
pub fn event_item(event: Event) -> Item

from_parts

</> 
pub fn from_parts(
  event_name event_name: option.Option(String),
  data data: String,
  id id: option.Option(String),
  retry retry: option.Option(Int),
) -> Event

id

</> 
pub fn id(event: Event, id: String) -> Event

id_of

</> 
pub fn id_of(event: Event) -> option.Option(String)

message

</> 
pub fn message(data: String) -> Event

name_of

</> 
pub fn name_of(event: Event) -> option.Option(String)

named

</> 
pub fn named(name: String, data: String) -> Event

new

</> 
pub fn new(data: String) -> Event

retry

</> 
pub fn retry(event: Event, milliseconds: Int) -> Event

retry_of

</> 
pub fn retry_of(event: Event) -> option.Option(Int)
✨ Search Document