offstage - v0.7.0

offstage/dynamic/serialize

Types

Context

opaque </> 
pub opaque type Context(t)

Decoder

</>

A decoder for a specific type t that knows how to parse a dynamic value and contains the openapi specification of that type.

pub type Decoder(t) {
  Decoder(
    decoder: decode.Decoder(t),
    doc: fn() -> openapi_type.OpenAPIType,
  )
}

Constructors

Encoder

</>

An encoder for a specific type t that knows how to encode a value into a dynamic spec and contains the openapi specification of that type.

pub type Encoder(t) {
  Encoder(
    encoder: fn(t) -> spec.Spec,
    doc: fn() -> openapi_type.OpenAPIType,
  )
}

Constructors

Serializer

</>

A serializer that allows encoding and decoding values

pub type Serializer(t) {
  Serializer(
    decoder: decode.Decoder(t),
    encoder: fn(t) -> spec.Spec,
    doc: fn() -> openapi_type.OpenAPIType,
  )
}

Constructors

Values

bool

</> 
pub fn bool() -> Serializer(Bool)

build

</> 
pub fn build(
  context: Context(t),
  value: t,
) -> decode.Decoder(#(Context(t), t))

decode

</> 
pub fn decode(
  value: dynamic.Dynamic,
  serializer: Serializer(t),
) -> Result(t, List(decode.DecodeError))

decoder

</> 
pub fn decoder(serializer: Serializer(t)) -> Decoder(t)

empty_object

</> 
pub fn empty_object() -> Serializer(Nil)

encode

</> 
pub fn encode(
  value: t,
  of serializer: Serializer(t),
) -> spec.Spec

encode_json

</> 
pub fn encode_json(
  a: a,
  of serializer: Serializer(a),
) -> json.Json

Directly encode a value using the given serializer to JSON.

encode_yaml

</> 
pub fn encode_yaml(
  a: a,
  of serializer: Serializer(a),
) -> value.YamlValue

Directly encode a value using the given serializer to JSON.

encoder

</> 
pub fn encoder(serializer: Serializer(t)) -> Encoder(t)

field

</> 
pub fn field(
  context context: Context(final),
  name name: String,
  serializer serializer: Serializer(t),
  getter getter: fn(final) -> t,
  next next: fn(Context(final), t) -> decode.Decoder(
    #(Context(final), final),
  ),
) -> decode.Decoder(#(Context(final), final))

float

</> 
pub fn float() -> Serializer(Float)

indexed_field

</> 
pub fn indexed_field(
  context context: Context(final),
  name name: String,
  count count: Int,
  serializer serializer: Serializer(t),
  getter getter: fn(final, Int) -> t,
  next next: fn(Context(final), List(t)) -> decode.Decoder(
    #(Context(final), final),
  ),
) -> decode.Decoder(#(Context(final), final))

int

</> 
pub fn int() -> Serializer(Int)

json_value

</> 
pub fn json_value() -> Serializer(json_value.JsonValue)

list

</> 
pub fn list(of inner: Serializer(t)) -> Serializer(List(t))

list_decoder

</> 
pub fn list_decoder(of inner: Decoder(t)) -> Decoder(List(t))

list_encoder

</> 
pub fn list_encoder(of inner: Encoder(t)) -> Encoder(List(t))

nil

</> 
pub fn nil() -> Serializer(Nil)

A serializer for the Nil type.

object

</> 
pub fn object(
  next: fn(Context(t)) -> decode.Decoder(#(Context(t), t)),
) -> Serializer(t)

optional

</> 
pub fn optional(
  of inner: Serializer(t),
) -> Serializer(option.Option(t))

optional_decoder

</> 
pub fn optional_decoder(
  of inner: Decoder(t),
) -> Decoder(option.Option(t))

optional_encoder

</> 
pub fn optional_encoder(
  of inner: Encoder(t),
) -> Encoder(option.Option(t))

optional_field

</> 
pub fn optional_field(
  context context: Context(final),
  name name: String,
  default default: t,
  serializer serializer: Serializer(t),
  getter getter: fn(final) -> t,
  next next: fn(Context(final), t) -> decode.Decoder(
    #(Context(final), final),
  ),
) -> decode.Decoder(#(Context(final), final))

optional_indexed_field

</> 
pub fn optional_indexed_field(
  context context: Context(final),
  name name: String,
  count count: Int,
  default default: t,
  serializer serializer: Serializer(t),
  getter getter: fn(final, Int) -> t,
  next next: fn(Context(final), List(t)) -> decode.Decoder(
    #(Context(final), final),
  ),
) -> decode.Decoder(#(Context(final), final))

string

</> 
pub fn string() -> Serializer(String)

A serializer for the String type

string_enum

</> 
pub fn string_enum(
  values: List(a),
  to_string: fn(a) -> String,
) -> Serializer(a)

success

</> 
pub fn success(value: t) -> decode.Decoder(t)

timestamp

</> 
pub fn timestamp() -> Serializer(timestamp.Timestamp)

with_default

</> 
pub fn with_default(
  serializer: Serializer(a),
  default: spec.Spec,
) -> Serializer(a)

Add a default value to the openapi specification of the given serializer.

with_example

</> 
pub fn with_example(
  serializer: Serializer(a),
  example: spec.Spec,
) -> Serializer(a)

Add an example to the openapi specification of the given serializer.

with_max

</> 
pub fn with_max(
  serializer: Serializer(a),
  max: spec.Spec,
) -> Serializer(a)

Add an maximum value to the openapi specification of the given serializer.

with_min

</> 
pub fn with_min(
  serializer: Serializer(a),
  min: spec.Spec,
) -> Serializer(a)

Add an minimum value to the openapi specification of the given serializer.

with_pattern

</> 
pub fn with_pattern(
  serializer: Serializer(a),
  pattern: String,
) -> Serializer(a)

Add a pattern to the openapi specification of the given serializer.

✨ Search Document