LavalinkConnection class
A websocket connection to a Lavalink server.
Provides a stream interface that exposes messages sent by the server and errors encountered by the connection.
- Inheritance
-
- Object
- Stream<
LavalinkMessage> - LavalinkConnection
Properties
- client → LavalinkClient
-
The client this connection is for.
final
-
first
→ Future<
LavalinkMessage> -
The first element of this stream.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isBroadcast → bool
-
Whether this stream is a broadcast stream.
no setterinherited
-
isEmpty
→ Future<
bool> -
Whether this stream contains any elements.
no setterinherited
-
last
→ Future<
LavalinkMessage> -
The last element of this stream.
no setterinherited
-
length
→ Future<
int> -
The number of elements in this stream.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sessionId → String
-
The ID of the current session this connection is using.
no setter
-
single
→ Future<
LavalinkMessage> -
The single element of this stream.
no setterinherited
Methods
-
any(
bool test(LavalinkMessage element)) → Future< bool> -
Checks whether
test
accepts any element provided by this stream.inherited -
asBroadcastStream(
{void onListen(StreamSubscription< LavalinkMessage> subscription)?, void onCancel(StreamSubscription<LavalinkMessage> subscription)?}) → Stream<LavalinkMessage> -
Returns a multi-subscription stream that produces the same events as this.
inherited
-
asyncExpand<
E> (Stream< E> ? convert(LavalinkMessage event)) → Stream<E> -
Transforms each element into a sequence of asynchronous events.
inherited
-
asyncMap<
E> (FutureOr< E> convert(LavalinkMessage event)) → Stream<E> -
Creates a new stream with each data event of this stream asynchronously
mapped to a new event.
inherited
-
cast<
R> () → Stream< R> -
Adapt this stream to be a
Stream<R>
.inherited -
close(
) → Future< void> - Close this connection and all associated resources.
-
contains(
Object? needle) → Future< bool> -
Returns whether
needle
occurs in the elements provided by this stream.inherited -
distinct(
[bool equals(LavalinkMessage previous, LavalinkMessage next)?]) → Stream< LavalinkMessage> -
Skips data events if they are equal to the previous data event.
inherited
-
drain<
E> ([E? futureValue]) → Future< E> -
Discards all data on this stream, but signals when it is done or an error
occurred.
inherited
-
elementAt(
int index) → Future< LavalinkMessage> -
Returns the value of the
index
th data event of this stream.inherited -
every(
bool test(LavalinkMessage element)) → Future< bool> -
Checks whether
test
accepts all elements provided by this stream.inherited -
expand<
S> (Iterable< S> convert(LavalinkMessage element)) → Stream<S> -
Transforms each element of this stream into a sequence of elements.
inherited
-
firstWhere(
bool test(LavalinkMessage element), {LavalinkMessage orElse()?}) → Future< LavalinkMessage> -
Finds the first element of this stream matching
test
.inherited -
fold<
S> (S initialValue, S combine(S previous, LavalinkMessage element)) → Future< S> -
Combines a sequence of values by repeatedly applying
combine
.inherited -
forEach(
void action(LavalinkMessage element)) → Future< void> -
Executes
action
on each element of this stream.inherited -
handleError(
Function onError, {bool test(dynamic error)?}) → Stream< LavalinkMessage> -
Creates a wrapper Stream that intercepts some errors from this stream.
inherited
-
join(
[String separator = ""]) → Future< String> -
Combines the string representation of elements into a single string.
inherited
-
lastWhere(
bool test(LavalinkMessage element), {LavalinkMessage orElse()?}) → Future< LavalinkMessage> -
Finds the last element in this stream matching
test
.inherited -
listen(
void onData(LavalinkMessage event)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription< LavalinkMessage> -
Adds a subscription to this stream.
override
-
map<
S> (S convert(LavalinkMessage event)) → Stream< S> -
Transforms each element of this stream into a new stream event.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pipe(
StreamConsumer< LavalinkMessage> streamConsumer) → Future -
Pipes the events of this stream into
streamConsumer
.inherited -
reduce(
LavalinkMessage combine(LavalinkMessage previous, LavalinkMessage element)) → Future< LavalinkMessage> -
Combines a sequence of values by repeatedly applying
combine
.inherited -
singleWhere(
bool test(LavalinkMessage element), {LavalinkMessage orElse()?}) → Future< LavalinkMessage> -
Finds the single element in this stream matching
test
.inherited -
skip(
int count) → Stream< LavalinkMessage> -
Skips the first
count
data events from this stream.inherited -
skipWhile(
bool test(LavalinkMessage element)) → Stream< LavalinkMessage> -
Skip data events from this stream while they are matched by
test
.inherited -
take(
int count) → Stream< LavalinkMessage> -
Provides at most the first
count
data events of this stream.inherited -
takeWhile(
bool test(LavalinkMessage element)) → Stream< LavalinkMessage> -
Forwards data events while
test
is successful.inherited -
timeout(
Duration timeLimit, {void onTimeout(EventSink< LavalinkMessage> sink)?}) → Stream<LavalinkMessage> -
Creates a new stream with the same events as this stream.
inherited
-
toList(
) → Future< List< LavalinkMessage> > -
Collects all elements of this stream in a List.
inherited
-
toSet(
) → Future< Set< LavalinkMessage> > -
Collects the data of this stream in a Set.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
transform<
S> (StreamTransformer< LavalinkMessage, S> streamTransformer) → Stream<S> -
Applies
streamTransformer
to this stream.inherited -
where(
bool test(LavalinkMessage event)) → Stream< LavalinkMessage> -
Creates a new stream from this stream that discards some elements.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
connect(
LavalinkClient client) → Future< LavalinkConnection> - Create a new connection to a Lavalink server and wait for it to be ready.