What a storage implements; make adds the reply handlers. Its
save_reply gives back the reply it persisted (a defect in place of
one that could not be encoded).
Functions#
save_request#
save_request(message) -> Effect[SaveResult, PersistenceError | MalformedMessage]| Parameter | Type | Description |
|---|---|---|
message | OutgoingRequest |
Returns Effect[SaveResult, PersistenceError | MalformedMessage]
def save_request(
self, message: OutgoingRequest, /
) -> Effect[SaveResult, PersistenceError | MalformedMessage]: ...save_envelope#
save_envelope(message) -> Effect[None, PersistenceError | MalformedMessage]| Parameter | Type | Description |
|---|---|---|
message | OutgoingEnvelope |
Returns Effect[None, PersistenceError | MalformedMessage]
def save_envelope(
self, message: OutgoingEnvelope, /
) -> Effect[None, PersistenceError | MalformedMessage]: ...save_reply#
save_reply(reply) -> Effect[ReplyWithContext, PersistenceError | MalformedMessage]| Parameter | Type | Description |
|---|---|---|
reply | ReplyWithContext |
Returns Effect[ReplyWithContext, PersistenceError | MalformedMessage]
def save_reply(
self, reply: ReplyWithContext, /
) -> Effect[ReplyWithContext, PersistenceError | MalformedMessage]: ...clear_replies#
clear_replies(request_id, /, *, expected_reply_id=None) -> Effect[None, PersistenceError]| Parameter | Type | Description |
|---|---|---|
request_id | Snowflake | |
expected_reply_id | Snowflake | None = None |
Returns Effect[None, PersistenceError]
def clear_replies(
self, request_id: Snowflake, /, *, expected_reply_id: Snowflake | None = None
) -> Effect[None, PersistenceError]: ...replies_for#
replies_for(requests) -> Effect[list[Reply], PersistenceError | MalformedMessage]| Parameter | Type | Description |
|---|---|---|
requests | Iterable[OutgoingRequest] |
Returns Effect[list[Reply], PersistenceError | MalformedMessage]
def replies_for(
self, requests: Iterable[OutgoingRequest], /
) -> Effect[list[Reply], PersistenceError | MalformedMessage]: ...replies_for_unfiltered#
replies_for_unfiltered(request_ids) -> Effect[list[Any], PersistenceError | MalformedMessage]| Parameter | Type | Description |
|---|---|---|
request_ids | Iterable[Snowflake] |
Returns Effect[list[Any], PersistenceError | MalformedMessage]
def replies_for_unfiltered(
self, request_ids: Iterable[Snowflake], /
) -> Effect[list[Any], PersistenceError | MalformedMessage]: ...request_id_for_primary_key#
request_id_for_primary_key(*, address, tag, id) -> Effect[Snowflake | None, PersistenceError]| Parameter | Type | Description |
|---|---|---|
address | EntityAddress | |
tag | str | |
id | str |
Returns Effect[Snowflake | None, PersistenceError]
def request_id_for_primary_key(
self, *, address: EntityAddress, tag: str, id: str
) -> Effect[Snowflake | None, PersistenceError]: ...unprocessed_messages#
unprocessed_messages(shard_ids, /, *, responder, limit=None, addresses=None) -> Effect[list[Incoming], PersistenceError]The unprocessed messages; responder (the storage reading
them, Effect's this) saves their replies and the defects of
malformed ones.
| Parameter | Type | Description |
|---|---|---|
shard_ids | Iterable[ShardId] | |
responder | MessageStorageService | |
limit | int | None = None | |
addresses | Sequence[EntityAddress] | None = None |
Returns Effect[list[Incoming], PersistenceError]
def unprocessed_messages(
self,
shard_ids: Iterable[ShardId],
/,
*,
responder: MessageStorageService,
limit: int | None = None,
addresses: Sequence[EntityAddress] | None = None,
) -> Effect[list[Incoming], PersistenceError]:
"""The unprocessed messages; ``responder`` (the storage reading
them, Effect's ``this``) saves their replies and the defects of
malformed ones."""
...unprocessed_messages_by_id#
unprocessed_messages_by_id(message_ids, /, *, responder) -> Effect[list[Incoming], PersistenceError]| Parameter | Type | Description |
|---|---|---|
message_ids | Iterable[Snowflake] | |
responder | MessageStorageService |
Returns Effect[list[Incoming], PersistenceError]
def unprocessed_messages_by_id(
self, message_ids: Iterable[Snowflake], /, *, responder: MessageStorageService
) -> Effect[list[Incoming], PersistenceError]: ...reset_shards#
reset_shards(shard_ids) -> Effect[None, PersistenceError]| Parameter | Type | Description |
|---|---|---|
shard_ids | Iterable[ShardId] |
Returns Effect[None, PersistenceError]
def reset_shards(self, shard_ids: Iterable[ShardId], /) -> Effect[None, PersistenceError]: ...reset_address#
reset_address(address) -> Effect[None, PersistenceError]| Parameter | Type | Description |
|---|---|---|
address | EntityAddress |
Returns Effect[None, PersistenceError]
def reset_address(self, address: EntityAddress, /) -> Effect[None, PersistenceError]: ...reset_requests#
reset_requests(request_ids) -> Effect[None, PersistenceError]| Parameter | Type | Description |
|---|---|---|
request_ids | Sequence[Snowflake] |
Returns Effect[None, PersistenceError]
def reset_requests(
self, request_ids: Sequence[Snowflake], /
) -> Effect[None, PersistenceError]: ...reset_addresses#
reset_addresses(addresses) -> Effect[None, PersistenceError]| Parameter | Type | Description |
|---|---|---|
addresses | Sequence[EntityAddress] |
Returns Effect[None, PersistenceError]
def reset_addresses(
self, addresses: Sequence[EntityAddress], /
) -> Effect[None, PersistenceError]: ...clear_address#
clear_address(address) -> Effect[None, PersistenceError]| Parameter | Type | Description |
|---|---|---|
address | EntityAddress |
Returns Effect[None, PersistenceError]
def clear_address(self, address: EntityAddress, /) -> Effect[None, PersistenceError]: ...with_transaction#
with_transaction[A, E, R](effect) -> Effect[A, E, R]| Parameter | Type | Description |
|---|---|---|
effect | Effect[A, E, R] |
Returns Effect[A, E, R]
def with_transaction[A, E, R](self, effect: Effect[A, E, R], /) -> Effect[A, E, R]: ...