View Source Unleash.Propagation.Serialization (Unleash v3.0.0)

Module handling the (de)serialization of Unleash objects for propagation. See Unleash.Propagation.

Summary

Functions

Link to this function

deserialize_context(serialized_context)

View Source
@spec deserialize_context(binary()) ::
  {:ok, Unleash.context()}
  | {:error, Unleash.Propagation.Serialization.ContextDeserializationError.t()}
Link to this function

deserialize_context!(serialized_context)

View Source
@spec deserialize_context!(binary()) :: Unleash.context()
Link to this function

deserialize_impressions(serialized_impressions)

View Source
@spec deserialize_impressions(binary()) ::
  {:ok, [Unleash.impression()]}
  | {:error,
     Unleash.Propagation.Serialization.ImpressionsDeserializationError.t()}
Link to this function

deserialize_impressions!(serialized_impressions)

View Source
@spec deserialize_impressions!(binary()) :: [Unleash.impression()]
Link to this function

deserialize_overrides(serialized_overrides)

View Source
@spec deserialize_overrides(binary()) ::
  {:ok, Unleash.context()}
  | {:error,
     Unleash.Propagation.Serialization.OverridesDeserializationError.t()}
Link to this function

deserialize_overrides!(serialized_overrides)

View Source
@spec deserialize_overrides!(binary()) :: Unleash.overrides()
Link to this function

serialize_context!(context)

View Source
@spec serialize_context!(Unleash.context()) :: String.t()

Serializes context for further propagation to downstream services.

Note that only propagation-friendly context fields are serialized.

Link to this function

serialize_impressions!(impressions)

View Source
@spec serialize_impressions!([Unleash.impression()]) :: String.t()
Link to this function

serialize_overrides!(overrides)

View Source
@spec serialize_overrides!(Unleash.overrides()) :: String.t()

Serializes overrides for further propagation to downstream services.

Link to this function

validate_context_properties(properties)

View Source