pedantic/codec

Types

Codec

A Codec wraps a standalone Decoder and Encoder, sharing their underlying TypeGraph.

pub type Codec(t) {
  Codec(
    graph: report.TypeGraph,
    decoder: decode.Decoder(t),
    encoder: encode.Encoder(t),
  )
}

Constructors

Codec(
  graph: report.TypeGraph,
  decoder: decode.Decoder(t),
  encoder: encode.Encoder(t),
)

ObjectBuilder

opaque </>

An intermediate builder structure used to construct record/object codecs.

pub opaque type ObjectBuilder(constructor, value)

Values

allow_chars

</>

pub fn allow_chars(
  codec: Codec(String),
  characters: String,
) -> Codec(String)

assert_that

</>

pub fn assert_that(
  codec: Codec(t),
  predicate: fn(t) -> Bool,
  error: report.ErrorKind,
) -> Codec(t)

bool

</>

pub const bool: Codec(Bool)

build

</>

pub fn build(
  builder: ObjectBuilder(value, value),
) -> Codec(value)

Finalizes the ObjectBuilder, converting it into a full bidirectional Codec.

check

</>

pub fn check(
  codec: Codec(t),
  predicate: fn(t) -> Bool,
  msg: String,
) -> Codec(t)

coerced_bool

</>

pub const coerced_bool: Codec(Bool)

coerced_float

</>

pub const coerced_float: Codec(Float)

coerced_int

</>

pub const coerced_int: Codec(Int)

coerced_string

</>

pub const coerced_string: Codec(String)

collapse_whitespace

</>

pub fn collapse_whitespace(codec: Codec(String)) -> Codec(String)

custom

</>

pub fn custom(
  decoder: decode.Decoder(t),
  encoder: encode.Encoder(t),
) -> Codec(t)

Bidirectional custom pair constructor.

default

</>

pub fn default(
  codec: Codec(option.Option(a)),
  default_val: a,
) -> Codec(a)

Adapts an optional codec with a default value fallback.

default_if_blank

</>

pub fn default_if_blank(
  codec: Codec(String),
  default_value: String,
) -> Codec(String)

default_to

</>

pub const default_to: fn(Codec(option.Option(a)), a) -> Codec(a)

describe

</>

pub fn describe(codec: Codec(t), desc: String) -> Codec(t)

Sets the description metadata in the AST graph.

dict

</>

pub fn dict(value_codec: Codec(a)) -> Codec(dict.Dict(String, a))

Dict combinator.

digits_only

</>

pub fn digits_only(codec: Codec(String)) -> Codec(String)

email

</>

pub fn email(codec: Codec(String), msg: String) -> Codec(String)

empty_as_none

</>

pub fn empty_as_none(
  codec: Codec(String),
) -> Codec(option.Option(String))

exact_bool

</>

pub const exact_bool: Codec(Bool)

exact_float

</>

pub const exact_float: Codec(Float)

exact_int

</>

pub const exact_int: Codec(Int)

exact_string

</>

pub const exact_string: Codec(String)

example

</>

pub fn example(codec: Codec(t), ex: dynamic.Dynamic) -> Codec(t)

Sets the example metadata in the AST graph.

field

</>

pub fn field(
  builder: ObjectBuilder(fn(field_type) -> next, value),
  name: String,
  field_codec: Codec(field_type),
  get: fn(value) -> field_type,
) -> ObjectBuilder(next, value)

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

float

</>

pub const float: Codec(Float)

int

</>

pub const int: Codec(Int)

key

</>

pub const key: fn(
  ObjectBuilder(fn(field_type) -> next, value),
  String,
  Codec(field_type),
  fn(value) -> field_type,
) -> ObjectBuilder(next, value)

key_optional

</>

pub fn key_optional(
  builder: ObjectBuilder(
    fn(option.Option(field_type)) -> next,
    value,
  ),
  name: String,
  field_codec: Codec(field_type),
  get: fn(value) -> option.Option(field_type),
) -> ObjectBuilder(next, value)

Declares an optional key in the object builder, resolving to Option(t).

key_required

</>

pub const key_required: fn(
  ObjectBuilder(fn(field_type) -> next, value),
  String,
  Codec(field_type),
  fn(value) -> field_type,
) -> ObjectBuilder(next, value)

key_with_default

</>

pub fn key_with_default(
  builder: ObjectBuilder(fn(field_type) -> next, value),
  name: String,
  field_codec: Codec(field_type),
  default_val: field_type,
  get: fn(value) -> field_type,
) -> ObjectBuilder(next, value)

Declares an optional key with fallback default value.

length

</>

pub fn length(codec: Codec(String), len: Int) -> Codec(String)

letters_only

</>

pub fn letters_only(codec: Codec(String)) -> Codec(String)

list

</>

pub fn list(element_codec: Codec(a)) -> Codec(List(a))

List combinator.

lowercase

</>

pub fn lowercase(codec: Codec(String)) -> Codec(String)

max

</>

pub fn max(codec: Codec(Int), maximum: Int) -> Codec(Int)

Restricts an Int codec to values less than or equal to the maximum.

max_length

</>

pub fn max_length(
  codec: Codec(String),
  maximum: Int,
) -> Codec(String)

Restricts a String codec to a maximum length.

max_size

</>

pub fn max_size(
  codec: Codec(List(a)),
  maximum: Int,
) -> Codec(List(a))

min

</>

pub fn min(codec: Codec(Int), minimum: Int) -> Codec(Int)

Restricts an Int codec to values greater than or equal to the minimum.

min_length

</>

pub fn min_length(
  codec: Codec(String),
  minimum: Int,
) -> Codec(String)

Restricts a String codec to a minimum length.

min_size

</>

pub fn min_size(
  codec: Codec(List(a)),
  minimum: Int,
) -> Codec(List(a))

negative

</>

pub fn negative(codec: Codec(Int)) -> Codec(Int)

non_empty_list

</>

pub fn non_empty_list(element_codec: Codec(a)) -> Codec(List(a))

non_negative

</>

pub fn non_negative(codec: Codec(Int)) -> Codec(Int)

non_positive

</>

pub fn non_positive(codec: Codec(Int)) -> Codec(Int)

normalize_email

</>

pub fn normalize_email(codec: Codec(String)) -> Codec(String)

normalize_line_endings

</>

pub fn normalize_line_endings(
  codec: Codec(String),
) -> Codec(String)

normalize_uuid

</>

pub fn normalize_uuid(codec: Codec(String)) -> Codec(String)

object

</>

pub fn object(
  name: String,
  constructor: constructor,
) -> ObjectBuilder(constructor, value)

Initializes an ObjectBuilder for a custom record constructor.

optional

</>

pub fn optional(inner_codec: Codec(a)) -> Codec(option.Option(a))

Option/Optional combinator representing absent or nullable values.

positive

</>

pub fn positive(codec: Codec(Int)) -> Codec(Int)

refine

</>

pub fn refine(
  codec: Codec(t),
  rule: fn(t) -> Result(t, report.ErrorKind),
) -> Codec(t)

Refines a codec with custom validation rules.

remove_chars

</>

pub fn remove_chars(
  codec: Codec(String),
  characters: String,
) -> Codec(String)

remove_whitespace

</>

pub fn remove_whitespace(codec: Codec(String)) -> Codec(String)

replace

</>

pub fn replace(
  codec: Codec(String),
  pattern: String,
  replacement: String,
) -> Codec(String)

string

</>

pub const string: Codec(String)

strip_control_chars

</>

pub fn strip_control_chars(codec: Codec(String)) -> Codec(String)

strip_non_ascii

</>

pub fn strip_non_ascii(codec: Codec(String)) -> Codec(String)

title

</>

pub fn title(codec: Codec(t), name: String) -> Codec(t)

Sets the title metadata in the AST graph.

trim

</>

pub fn trim(codec: Codec(String)) -> Codec(String)

unwrap_or

</>

pub const unwrap_or: fn(Codec(option.Option(a)), a) -> Codec(a)

uppercase

</>

pub fn uppercase(codec: Codec(String)) -> Codec(String)

uuid

</>

pub fn uuid(codec: Codec(String), msg: String) -> Codec(String)

with_error_formatter

</>

pub fn with_error_formatter(
  codec: Codec(t),
  formatter: fn(dynamic.Dynamic, report.ErrorKind) -> String,
) -> Codec(t)

with_error_message

</>

pub fn with_error_message(
  codec: Codec(t),
  msg: String,
) -> Codec(t)

with_template

</>

pub fn with_template(
  codec: Codec(t),
  template: String,
) -> Codec(t)