API Reference VerifiedPubSub v#0.1.0

Copy Markdown View Source

Modules

Compile-time verified PubSub.

The Spark DSL extension that VerifiedPubSub.Manifest uses.

A payload field that a manifest declares.

An event that a manifest declares on a topic.

A topic that a manifest declares, with its wire segments and its events.

The only supported way to read a manifest.

Declares the topics and events of an application.

The error for a message that a subscriber receives from a different manifest.

The struct that a subscriber receives for each verified broadcast.

Validates the payload of each broadcast against the manifest at runtime.

The error for a broadcast payload that does not match the shape that the manifest declares.

Declares that a module subscribes to topics of a manifest, and defines its handlers.

Checks at compile time that a VerifiedPubSub.Subscriber covers each event.

Builds the segment of a wire topic that a param fills.

The error for a param value that cannot safely fill its segment of the wire topic.

Defines __verified_pubsub_fields__/2 on the manifest, with one clause for each event.

Validates the segments of each topic, and finds the params in them.

Validates the type of each declared field at compile time.

Validates the topics and events of the manifest at compile time.

Mix Tasks

Installs VerifiedPubSub into a project.