RigCloudEvents.Parser behaviour (Reactive Interaction Gateway v3.0.0-alpha.2) View Source

context_attribute(t(), attribute()) ::
  {:ok, value :: any()}
  | {:error, {:not_found, Parser.attribute(), t()}}
  | {:error, {:non_scalar_value, Parser.attribute(), t()}}
  | {:error, any()}

Fetch the value of a CloudEvents context attribute.

extension_attribute(t, extension, attribute)

Specs

extension_attribute(t(), extension(), attribute()) ::
  {:ok, value :: any()}
  | {:error, {:not_found, Parser.attribute(), t()}}
  | {:error, {:not_an_object | :non_scalar_value, Parser.attribute(), t()}}
  | {:error, any()}

Fetch the value of a CloudEvents extension attribute.

find_value(t, json_pointer)

Specs

find_value(t(), json_pointer()) ::
  {:ok, value :: any()}
  | {:error, {:not_found, location :: String.t(), t()}}
  | {:error, {:non_scalar_value, location :: String.t(), t()}}
  | {:error, any()}

Find a specific value using a JSON Pointer.

parse(json_string)

Specs

parse(json_string()) :: t()

Parse a JSON encoded CloudEvent.