kata - v0.2.0

kata

Types

Ast

</> 
pub type Ast =
  ast.Ast

DecodeError

</> 
pub type DecodeError =
  format.DecodeError

Error

</> 
pub type Error =
  error.Error

Format

</> 
pub type Format(raw) =
  format.Format(raw)

ParseMode

</> 
pub type ParseMode =
  format.ParseMode

Schema

</> 
pub type Schema(a) =
  schema.Schema(a)

Value

</> 
pub type Value =
  value.Value

Values

bool

</> 
pub fn bool() -> schema.Schema(Bool)

brand

</> 
pub fn brand(
  base: schema.Schema(a),
  name: String,
  wrap: fn(a) -> b,
  unwrap: fn(b) -> a,
) -> schema.Schema(b)

decode

</> 
pub fn decode(
  s: schema.Schema(a),
  v: value.Value,
) -> Result(a, List(error.Error))

dict

</> 
pub fn dict(
  key_schema: schema.Schema(k),
  val_schema: schema.Schema(v),
) -> schema.Schema(dict.Dict(k, v))

done

</> 
pub fn done(value: a) -> schema.Schema(a)

encode

</> 
pub fn encode(s: schema.Schema(a), v: a) -> value.Value

field

</> 
pub fn field(
  key: String,
  field_schema: schema.Schema(a),
  get: fn(final) -> a,
  next: fn(a) -> schema.Schema(final),
) -> schema.Schema(final)

float

</> 
pub fn float() -> schema.Schema(Float)

from_bool

</> 
pub fn from_bool(
  s: schema.Schema(a),
  value: Bool,
) -> Result(a, List(error.Error))

Construct a validated value from a Bool.

from_float

</> 
pub fn from_float(
  s: schema.Schema(a),
  value: Float,
) -> Result(a, List(error.Error))

Construct a validated value from a Float.

from_int

</> 
pub fn from_int(
  s: schema.Schema(a),
  value: Int,
) -> Result(a, List(error.Error))

Construct a validated value from an Int.

from_string

</> 
pub fn from_string(
  s: schema.Schema(a),
  value: String,
) -> Result(a, List(error.Error))

Construct a validated value from a String. Useful for building smart constructors for branded opaque types.

pub fn new_email(s: String) -> Result(UserEmail, List(kata.Error)) {
  kata.from_string(user_email_schema(), s)
}

int

</> 
pub fn int() -> schema.Schema(Int)

lazy

</> 
pub fn lazy(f: fn() -> schema.Schema(a)) -> schema.Schema(a)

list

</> 
pub fn list(item: schema.Schema(a)) -> schema.Schema(List(a))

optional

</> 
pub fn optional(
  inner: schema.Schema(a),
) -> schema.Schema(option.Option(a))

optional_field

</> 
pub fn optional_field(
  key: String,
  field_schema: schema.Schema(a),
  default: a,
  get: fn(final) -> a,
  next: fn(a) -> schema.Schema(final),
) -> schema.Schema(final)

string

</> 
pub fn string() -> schema.Schema(String)

tagged_union

</> 
pub fn tagged_union(
  discriminator: String,
  get_tag: fn(a) -> String,
  variants: List(#(String, schema.Schema(a))),
) -> schema.Schema(a)

to_ast

</> 
pub fn to_ast(s: schema.Schema(a)) -> ast.Ast

transform

</> 
pub fn transform(
  s: schema.Schema(a),
  name: String,
  forward: fn(a) -> Result(b, String),
  backward: fn(b) -> a,
  dummy: fn() -> b,
) -> schema.Schema(b)
✨ Search Document