pedantic - v0.1.1

pedantic/encode

Types

Encoder

</>

An Encoder describes how to serialize a domain value back to Dynamic.

pub type Encoder(t) {
  Encoder(
    graph: report.TypeGraph,
    function: fn(t) -> dynamic.Dynamic,
  )
}

Constructors

ObjectBuilder

opaque </>

An intermediate builder structure used to construct record encoders.

pub opaque type ObjectBuilder(value)

Values

bool

</> 
pub const bool: Encoder(Bool)

Primitive Bool encoder.

build

</> 
pub fn build(builder: ObjectBuilder(value)) -> Encoder(value)

Finalizes the ObjectBuilder, converting it into a full Encoder.

describe

</> 
pub fn describe(encoder: Encoder(t), desc: String) -> Encoder(t)

Sets the description metadata in the AST graph.

dict

</> 
pub fn dict(
  value_encoder: Encoder(a),
) -> Encoder(dict.Dict(String, a))

Dict combinator to encode dictionaries to dynamic objects.

example

</> 
pub fn example(
  encoder: Encoder(t),
  ex: dynamic.Dynamic,
) -> Encoder(t)

Sets the example metadata in the AST graph.

field

</> 
pub fn field(
  builder: ObjectBuilder(value),
  name: String,
  field_encoder: Encoder(field_type),
  get: fn(value) -> field_type,
) -> ObjectBuilder(value)

Applies a field description, encoder, and getter to the object builder.

float

</> 
pub const float: Encoder(Float)

Primitive Float encoder.

int

</> 
pub const int: Encoder(Int)

Primitive Int encoder.

list

</> 
pub fn list(element_encoder: Encoder(a)) -> Encoder(List(a))

List combinator to encode lists to dynamic arrays.

object

</> 
pub fn object(name: String) -> ObjectBuilder(value)

Initializes an ObjectBuilder for a custom record constructor.

optional

</> 
pub fn optional(
  inner_encoder: Encoder(a),
) -> Encoder(option.Option(a))

Option/Optional combinator representing absent or nullable values.

string

</> 
pub const string: Encoder(String)

Primitive String encoder.

title

</> 
pub fn title(encoder: Encoder(t), name: String) -> Encoder(t)

Sets the title metadata in the AST graph.

✨ Search Document