EventStoreStreamsReadMixin mixin
- Superclass Constraints
- Mixin Applications
-
Methods
-
$createChannel(EndPoint endPoint)
→ GrpcOrGrpcWebClientChannel
-
inherited
-
$getClient()
→ Future<StreamsClient>
-
inherited
-
$toEnumerator(ResponseStream<ReadResp> stream, StreamState expected)
→ Future<ReadEnumerator<ReadResp>>
-
inherited
-
discover()
→ Future<EndPoint>
-
Discover node
EndPoint
given current
EventStoreClientSettings.nodePreference.
inherited
-
isFeatureSupported(ApiFeature feature)
→ bool
-
Check if given
feature
is supported by api.
inherited
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
read(String streamId, {int? maxCount, bool forward = true, bool resolveLinks = true, Position? position, UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions})
→ Future<ReadEventsResult>
-
Read ResolvedEvents from given stream
streamId
and optional position
.
When position
is not given, all events from StreamPosition.start
is returned when forward
is true and StreamPosition.end when
forward
is false.
Use maxCount
to limit number of events to read (default is all events
from given position).
Use forward
to read towards the end of stream. Default is true.
Use resolveLinks
to resolve links as ResolvedEvent (default is true).
Returns as ReadEventsResult
on first response from the server.
-
readFromAll({int? maxCount, bool forward = true, LogPosition? position, bool resolveLinks = true, UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions})
→ Future<ReadEventsResult>
-
Read all ResolvedEvents in EventStore from optional
position
. When
position
is not given, all events from LogPosition.start is
returned when forward
is true and StreamPosition.end when
forward
is false.
Use maxCount
to limit number of events to read (default is all events
from given position).
Use forward
to read towards the end of stream. Default is true.
Use resolveLinks
to resolve links as ResolvedEvent (default is true).
Returns as ReadEventsResult
on first response from the server.
-
shutdown()
→ Future<void>
-
Shutdown all channels
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
-
verify()
→ Future<void>
-
Verify that EventStoreClientSettings.apiVersion
is compatible with server version. Throws a
UnsupportedApiVersionException if
MemberInfo.apiVersion is incompatible with
requested EventStoreClientSettings.apiVersion.
inherited