Matrix-Mirrors/anonymousland-synapse
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse.git synced 2025-05-03 02:34:50 -04:00
Code Issues Projects Releases Packages Wiki Activity

Assume key existence. Update docstrings

Browse source
This commit is contained in:
Erik Johnston 2019-07-05 14:07:56 +01:00
parent c061d4f237
commit 9ccea16d45
2 changed files with 11 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

16
synapse/storage/stream.py
View file

@ -833,7 +833,9 @@ class StreamWorkerStore(EventsWorkerStore, SQLBaseStore):
Returns:
Deferred[tuple[list[_EventDictReturn], str]]: Returns the results
as a list of _EventDictReturn and a token that points to the end
of the result set.
of the result set. If no events are returned then the end of the
stream has been reached (i.e. there are no events between
`from_token` and `to_token`).
"""
assert int(limit) >= 0
@ -905,15 +907,17 @@ class StreamWorkerStore(EventsWorkerStore, SQLBaseStore):
only those before
direction(char): Either 'b' or 'f' to indicate whether we are
paginating forwards or backwards from `from_key`.
limit (int): The maximum number of events to return. Zero or less
means no limit.
limit (int): The maximum number of events to return.
event_filter (Filter|None): If provided filters the events to
those that match the filter.
Returns:
tuple[list[dict], str]: Returns the results as a list of dicts and
a token that points to the end of the result set. The dicts have
the keys "event_id", "topological_ordering" and "stream_orderign".
tuple[list[FrozenEvents], str]: Returns the results as a list of
dicts and a token that points to the end of the result set. The
dicts have the keys "event_id", "topological_ordering" and
"stream_ordering". If no events are returned then the end of the
stream has been reached (i.e. there are no events between
`from_key` and `to_key`).
"""
from_key = RoomStreamToken.parse(from_key)