ssevents - v0.8.0

ssevents/event

Event and item domain values.

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

Types

Comment

opaque </>

A :-prefixed comment line in an SSE stream.

Opaque — construct with comment/1 and inspect with comment_text_of/1. Comment text is sanitised at construction (CR / LF / NUL stripped) so decode(encode([CommentItem(c)])) returns the same Comment value: WHATWG SSE §9.2.6 has no notion of a multi-line comment, so any embedded line break would fan out to multiple comments on the wire and break the round-trip law.

pub opaque type Comment

Event

opaque </> 
pub opaque type Event

Item

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

Constructors

Values

comment

</> 
pub fn comment(text: String) -> Comment

Build a Comment from a text payload. CR (U+000D), LF (U+000A), and NUL (U+0000) are stripped at construction so the result round-trips through encode → decode without fanning out into multiple comments. Matches the sanitize_field_value posture already used for event_name and id.

comment_item

</> 
pub fn comment_item(text: String) -> Item

Wrap a Comment as a stream item. Convenience for the common CommentItem(comment(text)) two-step.

comment_text_of

</> 
pub fn comment_text_of(c: Comment) -> String

Extract the sanitised comment text.

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