libduvet/model/decoding · libduvet

as_object_or_none

pub fn as_object_or_none(
  value: dynamic.Dynamic,
) -> option.Option(dict.Dict(String, dynamic.Dynamic))

A value already in hand, read as an object when it is one.

as_string_or_none

</>

pub fn as_string_or_none(
  value: dynamic.Dynamic,
) -> option.Option(String)

A value already in hand, read as a string when it is one.

bool

</>

pub fn bool(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> Bool

bool_or

</>

pub fn bool_or(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
  default: Bool,
) -> Bool

empty_object

</>

pub fn empty_object() -> dict.Dict(String, dynamic.Dynamic)

field

</>

pub fn field(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> option.Option(dynamic.Dynamic)

The value at [key], when the object has it and it isn’t null.

format_time

</>

pub fn format_time(parsed: timestamp.Timestamp) -> String

A timestamp as Dart’s DateTime.toUtc().toIso8601String() writes it: microseconds when there are any, milliseconds otherwise.

int

</>

pub fn int(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> Int

int_list_value

</>

pub fn int_list_value(
  value: dynamic.Dynamic,
  key: String,
) -> List(Int)

A value already in hand, read as a list of integers.

int_or

</>

pub fn int_or(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
  default: Int,
) -> Int

int_value

</>

pub fn int_value(value: dynamic.Dynamic, key: String) -> Int

A value already in hand, read as an integer.

list

</>

pub fn list(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
  decode decode: fn(dynamic.Dynamic) -> item,
) -> List(item)

A list that must be there, whose items [decode] reads.

list_or_empty

</>

pub fn list_or_empty(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
  decode decode: fn(dynamic.Dynamic) -> item,
) -> List(item)

The field as a list, or [] when it is null or missing.

map

</>

pub fn map(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
  decode decode: fn(dynamic.Dynamic) -> item,
) -> dict.Dict(String, item)

map_objects

</>

pub fn map_objects(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
  read: fn(dict.Dict(String, dynamic.Dynamic)) -> item,
) -> dict.Dict(String, item)

A map of objects, each read by [read].

map_objects_or_empty

</>

pub fn map_objects_or_empty(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
  read: fn(dict.Dict(String, dynamic.Dynamic)) -> item,
) -> dict.Dict(String, item)

map_or_empty

</>

pub fn map_or_empty(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
  decode decode: fn(dynamic.Dynamic) -> item,
) -> dict.Dict(String, item)

number

</>

pub fn number(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> Float

A num field: an integer or a decimal, as a float.

object

</>

pub fn object(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> dict.Dict(String, dynamic.Dynamic)

An object field that must be there.

object_value

</>

pub fn object_value(
  value: dynamic.Dynamic,
  key: String,
) -> dict.Dict(String, dynamic.Dynamic)

A value already in hand, read as an object.

objects

</>

pub fn objects(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
  read: fn(dict.Dict(String, dynamic.Dynamic)) -> item,
) -> List(item)

A list of objects, each read by [read].

objects_or_empty

</>

pub fn objects_or_empty(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
  read: fn(dict.Dict(String, dynamic.Dynamic)) -> item,
) -> List(item)

objects_value

</>

pub fn objects_value(
  value: dynamic.Dynamic,
) -> List(dict.Dict(String, dynamic.Dynamic))

A value already in hand, read as a list of objects; null reads as none.

on_object

</>

pub fn on_object(
  read: fn(dict.Dict(String, dynamic.Dynamic)) -> item,
) -> fn(dynamic.Dynamic) -> item

Turns a model’s decoder into one for the model’s position in a list or a map, where the value arrives still untyped.

optional_bool

</>

pub fn optional_bool(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> option.Option(Bool)

optional_int

</>

pub fn optional_int(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> option.Option(Int)

optional_list

</>

pub fn optional_list(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
  decode decode: fn(dynamic.Dynamic) -> item,
) -> option.Option(List(item))

A list whose items [decode] reads, when the field is there and not null.

optional_map

</>

pub fn optional_map(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
  decode decode: fn(dynamic.Dynamic) -> item,
) -> option.Option(dict.Dict(String, item))

optional_number

</>

pub fn optional_number(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> option.Option(Float)

optional_object

</>

pub fn optional_object(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> option.Option(dict.Dict(String, dynamic.Dynamic))

optional_objects

</>

pub fn optional_objects(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
  read: fn(dict.Dict(String, dynamic.Dynamic)) -> item,
) -> option.Option(List(item))

optional_string

</>

pub fn optional_string(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> option.Option(String)

optional_string_list

</>

pub fn optional_string_list(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> option.Option(List(String))

optional_string_map

</>

pub fn optional_string_map(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> option.Option(dict.Dict(String, String))

optional_string_when_string

</>

pub fn optional_string_when_string(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> option.Option(String)

The field when it is a string, and None when it isn’t (a credential that isn’t a password is an object, and is left out).

optional_time

</>

pub fn optional_time(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> option.Option(timestamp.Timestamp)

parse_time

</>

pub fn parse_time(
  text: String,
  key: String,
) -> timestamp.Timestamp

string

</>

pub fn string(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> String

string_list

</>

pub fn string_list(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> List(String)

string_list_or_empty

</>

pub fn string_list_or_empty(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> List(String)

string_list_value

</>

pub fn string_list_value(
  value: dynamic.Dynamic,
  key: String,
) -> List(String)

A value already in hand, read as a list of strings.

string_map

</>

pub fn string_map(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> dict.Dict(String, String)

string_map_or_empty

</>

pub fn string_map_or_empty(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> dict.Dict(String, String)

string_or

</>

pub fn string_or(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
  default: String,
) -> String

The field as a string, or [default] when it is null or missing.

string_or_string_list_value

</>

pub fn string_or_string_list_value(
  value: dynamic.Dynamic,
  key: String,
) -> List(String)

A value already in hand, read as one string or a list of them (a “urls” field takes either); anything else reads as [].

time

</>

pub fn time(
  object: dict.Dict(String, dynamic.Dynamic),
  key: String,
) -> timestamp.Timestamp

A timestamp, as DateTime.parse reads one.

Dart keeps microseconds, so anything finer is dropped here too: two timestamps that differ only below a microsecond are the same one.