skir_client

Types

Serializer

A value that can serialize and deserialize values of type a to/from JSON and binary formats.

Do not construct this directly, use the *_serializer() functions.

pub type Serializer(a) =
  serializer.Serializer(a)

Timestamp

</>

A timestamp represented as milliseconds since the Unix epoch (1970-01-01T00:00:00Z).

pub type Timestamp =
  timestamp.Timestamp

Values

bytes_serializer

</>

pub fn bytes_serializer() -> serializer.Serializer(BitArray)

Returns the serializer for BitArray (bytes) values.

float32_serializer

</>

pub fn float32_serializer() -> serializer.Serializer(Float)

Returns the serializer for Float (float32) values.

float64_serializer

</>

pub fn float64_serializer() -> serializer.Serializer(Float)

Returns the serializer for Float (float64) values.

from_bytes

</>

pub fn from_bytes(
  serializer: serializer.Serializer(a),
  bytes: BitArray,
) -> Result(a, String)

Deserializes a value from binary format. Unrecognized fields are dropped.

from_bytes_with_options

</>

pub fn from_bytes_with_options(
  serializer: serializer.Serializer(a),
  bytes: BitArray,
  keep_unrecognized_values keep_unrecognized_values: Bool,
) -> Result(a, String)

Deserializes a value from binary format. When keep_unrecognized_values is True, field data that this client does not recognise is preserved in unrecognized_fields_.

from_gleam_timestamp

</>

pub fn from_gleam_timestamp(
  t: timestamp.Timestamp,
) -> timestamp.Timestamp

Converts a Gleam Timestamp to a Skir Timestamp.

from_json_code

</>

pub fn from_json_code(
  serializer: serializer.Serializer(a),
  json_code: String,
) -> Result(a, String)

Deserializes a value from a JSON string. Accepts both dense and readable JSON. Unrecognized fields are dropped.

from_json_code_with_options

</>

pub fn from_json_code_with_options(
  serializer: serializer.Serializer(a),
  json_code: String,
  keep_unrecognized_values keep_unrecognized_values: Bool,
) -> Result(a, String)

Deserializes a value from a JSON string. When keep_unrecognized_values is True, field data that this client does not recognise is preserved in unrecognized_fields_ so that re-serializing the value does not silently discard forward-compatible fields.

hash64_serializer

</>

pub fn hash64_serializer() -> serializer.Serializer(Int)

Returns the serializer for Int (hash64) values.

int32_serializer

</>

pub fn int32_serializer() -> serializer.Serializer(Int)

Returns the serializer for Int (int32) values.

int64_serializer

</>

pub fn int64_serializer() -> serializer.Serializer(Int)

Returns the serializer for Int (int64) values.

json_decoder

</>

pub fn json_decoder(
  serializer: serializer.Serializer(a),
) -> decode.Decoder(a)

Returns a JSON decoder for this serializer (Drop mode).

json_decoder_with_options

</>

pub fn json_decoder_with_options(
  serializer: serializer.Serializer(a),
  keep_unrecognized_values keep_unrecognized_values: Bool,
) -> decode.Decoder(a)

Returns a JSON decoder for this serializer with configurable keep/drop mode.

keyed_list_serializer

</>

pub fn keyed_list_serializer(
  item_serializer: serializer.Serializer(a),
  key_extractor: String,
) -> serializer.Serializer(List(a))

Returns a keyed serializer for List(a) values.

list_serializer

</>

pub fn list_serializer(
  item_serializer: serializer.Serializer(a),
) -> serializer.Serializer(List(a))

Returns a serializer for List(a) values.

optional_serializer

</>

pub fn optional_serializer(
  item_serializer: serializer.Serializer(a),
) -> serializer.Serializer(option.Option(a))

Returns a serializer for Option(a) values.

recursive_serializer

</>

pub fn recursive_serializer(
  item_serializer: serializer.Serializer(a),
) -> serializer.Serializer(recursive.Recursive(a))

Returns a serializer for Recursive(a) values.

string_serializer

</>

pub fn string_serializer() -> serializer.Serializer(String)

Returns the serializer for String values.

timestamp_serializer

</>

pub fn timestamp_serializer() -> serializer.Serializer(
  timestamp.Timestamp,
)

Returns the serializer for Timestamp values.

to_bytes

</>

pub fn to_bytes(
  serializer: serializer.Serializer(a),
  value: a,
) -> BitArray

Serializes a value to a compact binary format.

to_dense_json

</>

pub fn to_dense_json(
  serializer: serializer.Serializer(a),
  value: a,
) -> json.Json

Serializes a value to dense (field-index-based) JSON value.

to_dense_json_code

</>

pub fn to_dense_json_code(
  serializer: serializer.Serializer(a),
  value: a,
) -> String

Serializes a value to dense (field-index-based) JSON code. Dense JSON is safe for persistent storage: renaming a field does not break deserialization.

to_gleam_timestamp

</>

pub fn to_gleam_timestamp(
  t: timestamp.Timestamp,
) -> timestamp.Timestamp

Converts a Skir Timestamp to a Gleam Timestamp.

to_readable_json

</>

pub fn to_readable_json(
  serializer: serializer.Serializer(a),
  value: a,
) -> json.Json

Serializes a value to readable (field-name-based) JSON value.

to_readable_json_code

</>

pub fn to_readable_json_code(
  serializer: serializer.Serializer(a),
  value: a,
) -> String

Serializes a value to readable (field-name-based, indented) JSON code. Uses 2-space indentation.

type_descriptor

</>

pub fn type_descriptor(
  serializer: serializer.Serializer(a),
) -> type_descriptor.TypeDescriptor

Returns the TypeDescriptor for the type this serializer handles.

unix_epoch

</>

pub const unix_epoch: timestamp.Timestamp

The default Timestamp: the Unix epoch (1970-01-01T00:00:00Z).

skir_client - v1.0.0