eventstoredb.client.read_all.mixin#

Module Contents#

Classes#

ReadAllMixin

Base class for protocol classes.
class eventstoredb.client.read_all.mixin.ReadAllMixin[source]#

Bases: eventstoredb.client.protocol.ClientProtocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...
async read_all(options=None)[source]#
Parameters:

options (eventstoredb.client.read_all.types.ReadAllOptions | None) –

Return type:

collections.abc.AsyncIterator[eventstoredb.events.ReadEvent | eventstoredb.events.CaughtUp | eventstoredb.events.FellBehind]