GitHub

DehydratedAtom

API reference for DehydratedAtom.

A serializable atom's encoded value under its serialization key, when it was dehydrated (epoch milliseconds) and, for an Initial dehydrated with encode_initial_as="deferred", the deferred settling with its first other value (failing with the SchemaError if that value cannot be encoded).

Attributes

AttributeTypeDescription
keystr
valueobject
dehydrated_atint
result_deferredDeferred[object, SchemaError] | None = None

Functions

__init__

__init__(key, value, dehydrated_at, result_deferred=None) -> None
ParameterTypeDescription
keystr
valueobject
dehydrated_atint
result_deferredDeferred[object, SchemaError] | None = None

to_json

to_json() -> dict[str, object]

The entry as Effect writes it (result_deferred is not sent).

Returns dict[str, object]

def to_json(self) -> dict[str, object]:
    """The entry as Effect writes it (``result_deferred`` is not sent)."""
    return {
        _MARKER: True,
        "key": self.key,
        "value": self.value,
        "dehydratedAt": self.dehydrated_at,
    }

from_json

from_json(entry) -> DehydratedAtom

An entry written by to_json (or by Effect).

ParameterTypeDescription
entryMapping[str, Any]

Returns DehydratedAtom

@staticmethod
def from_json(entry: Mapping[str, Any]) -> DehydratedAtom:
    """An entry written by ``to_json`` (or by Effect)."""
    return DehydratedAtom(entry["key"], entry["value"], int(entry["dehydratedAt"]))