GitHub

EncodedStorage

API reference for EncodedStorage.

What a message storage driver implements (Effect's MessageStorage.Encoded). Lists it is given are never empty.

Functions

save_envelope

save_envelope(envelope, primary_key, deliver_at) -> Effect[SaveResultEncoded, PersistenceError]
ParameterTypeDescription
envelopeEnvelopeEncoded
primary_keystr | None
deliver_atint | None

Returns Effect[SaveResultEncoded, PersistenceError]

def save_envelope(
    self, envelope: EnvelopeEncoded, primary_key: str | None, deliver_at: int | None, /
) -> Effect[SaveResultEncoded, PersistenceError]: ...

save_reply

save_reply(reply) -> Effect[None, PersistenceError]
ParameterTypeDescription
replyreply_.Encoded

Returns Effect[None, PersistenceError]

def save_reply(self, reply: reply_.Encoded, /) -> Effect[None, PersistenceError]: ...

clear_replies

clear_replies(request_id, /, *, expected_reply_id=None) -> Effect[None, PersistenceError]
ParameterTypeDescription
request_idSnowflake
expected_reply_idSnowflake | None = None

Returns Effect[None, PersistenceError]

def clear_replies(
    self, request_id: Snowflake, /, *, expected_reply_id: Snowflake | None = None
) -> Effect[None, PersistenceError]: ...

request_id_for_primary_key

request_id_for_primary_key(primary_key) -> Effect[Snowflake | None, PersistenceError]
ParameterTypeDescription
primary_keystr

Returns Effect[Snowflake | None, PersistenceError]

def request_id_for_primary_key(
    self, primary_key: str, /
) -> Effect[Snowflake | None, PersistenceError]: ...

replies_for

replies_for(request_ids) -> Effect[list[reply_.Encoded], PersistenceError]
ParameterTypeDescription
request_idsSequence[str]

Returns Effect[list[reply_.Encoded], PersistenceError]

def replies_for(
    self, request_ids: Sequence[str], /
) -> Effect[list[reply_.Encoded], PersistenceError]: ...

replies_for_unfiltered

replies_for_unfiltered(request_ids) -> Effect[list[reply_.Encoded], PersistenceError]
ParameterTypeDescription
request_idsSequence[str]

Returns Effect[list[reply_.Encoded], PersistenceError]

def replies_for_unfiltered(
    self, request_ids: Sequence[str], /
) -> Effect[list[reply_.Encoded], PersistenceError]: ...

unprocessed_messages

unprocessed_messages(shard_ids, now, /, *, limit=None, addresses=None) -> Effect[list[EncodedMessage], PersistenceError]
ParameterTypeDescription
shard_idsSequence[str]
nowint
limitint | None = None
addressesSequence[EntityAddress] | None = None

Returns Effect[list[EncodedMessage], PersistenceError]

def unprocessed_messages(
    self,
    shard_ids: Sequence[str],
    now: int,
    /,
    *,
    limit: int | None = None,
    addresses: Sequence[EntityAddress] | None = None,
) -> Effect[list[EncodedMessage], PersistenceError]: ...

unprocessed_messages_by_id

unprocessed_messages_by_id(message_ids, now) -> Effect[list[EncodedMessage], PersistenceError]
ParameterTypeDescription
message_idsSequence[Snowflake]
nowint

Returns Effect[list[EncodedMessage], PersistenceError]

def unprocessed_messages_by_id(
    self, message_ids: Sequence[Snowflake], now: int, /
) -> Effect[list[EncodedMessage], PersistenceError]: ...

reset_requests

reset_requests(request_ids) -> Effect[None, PersistenceError]
ParameterTypeDescription
request_idsSequence[Snowflake]

Returns Effect[None, PersistenceError]

def reset_requests(
    self, request_ids: Sequence[Snowflake], /
) -> Effect[None, PersistenceError]: ...

reset_addresses

reset_addresses(addresses) -> Effect[None, PersistenceError]
ParameterTypeDescription
addressesSequence[EntityAddress]

Returns Effect[None, PersistenceError]

def reset_addresses(
    self, addresses: Sequence[EntityAddress], /
) -> Effect[None, PersistenceError]: ...

clear_address

clear_address(address) -> Effect[None, PersistenceError]
ParameterTypeDescription
addressEntityAddress

Returns Effect[None, PersistenceError]

def clear_address(self, address: EntityAddress, /) -> Effect[None, PersistenceError]: ...

reset_shards

reset_shards(shard_ids) -> Effect[None, PersistenceError]
ParameterTypeDescription
shard_idsSequence[str]

Returns Effect[None, PersistenceError]

def reset_shards(self, shard_ids: Sequence[str], /) -> Effect[None, PersistenceError]: ...

with_transaction

with_transaction[A, E, R](effect) -> Effect[A, E, R]
ParameterTypeDescription
effectEffect[A, E, R]

Returns Effect[A, E, R]

def with_transaction[A, E, R](self, effect: Effect[A, E, R], /) -> Effect[A, E, R]: ...