GitHub

singleton

API reference for singleton.

Singletons (Effect's Singleton): an effect run on exactly one runner of the cluster, the one owning its shard.

Functions

make

make[E](name: str, run: Effect[None, E, Scope], /, *, shard_group: str | None = None) -> Layer[Never, Never, Sharding]
make[E, R](name: str, run: Effect[None, E, R | Scope], /, *, shard_group: str | None = None) -> Layer[Never, Never, Sharding | R]

Register run as the singleton name (in shard_group, "default" when None) with Sharding: the runner owning its shard runs it, and moves it when the shard moves.

ParameterTypeDescription
name
run
shard_group= None
@overload
def make[E](
    name: str, run: Effect[None, E, Scope], /, *, shard_group: str | None = None
) -> Layer[Never, Never, Sharding]: ...
@overload
def make[E, R](
    name: str, run: Effect[None, E, R | Scope], /, *, shard_group: str | None = None
) -> Layer[Never, Never, Sharding | R]: ...
def make(
    name: str, run: Effect[None, Any, Any], /, *, shard_group: str | None = None
) -> Layer[Never, Never, Any]:
    """Register ``run`` as the singleton ``name`` (in ``shard_group``,
    ``"default"`` when ``None``) with ``Sharding``: the runner owning its
    shard runs it, and moves it when the shard moves."""
    require_effect(run, "run")
    return layer_.effect_discard(
        Sharding().flat_map(lambda sharding: sharding.register_singleton(name, run, shard_group))
    )