actorx/types

Core types for ActorX - Reactive Extensions for Gleam

This module defines the fundamental types for reactive programming:

Types

Disposable represents a resource that can be cleaned up. Call the dispose function to release resources and unsubscribe.

pub type Disposable {
  Disposable(dispose: fn() -> Nil)
}

</>

Notification represents the three types of events in the Rx grammar: OnNext* (OnError | OnCompleted)?

pub type Notification(a) {
  OnNext(a)
  OnError(String)
  OnCompleted
}

</>

Observable is a source of asynchronous events. Subscribe with an Observer to receive notifications.

pub type Observable(a) {
  Observable(subscribe: fn(Observer(a)) -> Disposable)
}

Observable(subscribe: fn(Observer(a)) -> Disposable)

</>

Observer receives notifications from an Observable.

The Rx contract guarantees:

pub type Observer(a) {
  Observer(notify: fn(Notification(a)) -> Nil)
}

Observer(notify: fn(Notification(a)) -> Nil)

</>

pub fn composite_disposable(
  disposables: List(Disposable),
) -> Disposable

Combine multiple disposables into one. When disposed, all inner disposables are disposed.

</>

pub fn empty_disposable() -> Disposable

Create an empty disposable that does nothing when disposed.

</>

pub fn make_next_observer(on_next: fn(a) -> Nil) -> Observer(a)

Create an observer that only handles OnNext events. OnError and OnCompleted are ignored.

</>

pub fn make_observer(
  on_next: fn(a) -> Nil,
  on_error: fn(String) -> Nil,
  on_completed: fn() -> Nil,
) -> Observer(a)

Create an observer from three callback functions. This is convenient for subscribers who want to handle each event type separately.

</>

pub fn notify(
  observer: Observer(a),
  notification: Notification(a),
) -> Nil

Forward a notification to an observer.

</>

pub fn on_completed(observer: Observer(a)) -> Nil

Send an OnCompleted notification to an observer.

</>

pub fn on_error(observer: Observer(a), error: String) -> Nil

Send an OnError notification to an observer.

</>

pub fn on_next(observer: Observer(a), value: a) -> Nil

Send an OnNext notification to an observer.