Class LyricsResult

Namespace

Nyra.Entities

Assembly

Nyra.dll

Result of a lyrics load, the data shape depends on LoadType.

public sealed record LyricsResult : IEquatable<LyricsResult>

Inheritance

object

LyricsResult

Implements

IEquatable<LyricsResult>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Data

The lyrics on Lyrics, the error details on Error, an empty object on Empty (NodeLink).

[JsonPropertyName("data")]
[JsonInclude]
public LyricsData? Data { get; }

Property Value

LyricsData

Remarks

On Unknown it holds whatever the server put in the envelope's data slot, if anything. Null on Lavalink, whose 204 carries no body.

LoadType

The outcome of the lyrics load.

[JsonPropertyName("loadType")]
[JsonInclude]
public LyricsLoadType LoadType { get; }

Property Value

LyricsLoadType

Methods

Equals(LyricsResult?)

Indicates whether the results carry the same load type and data.

public bool Equals(LyricsResult? other)

Parameters

other LyricsResult

The result to compare with.

Returns

bool

Whether the load type matches and the data compares equal.

GetHashCode()

Returns a hash of the result's comparable members.

public override int GetHashCode()

Returns

int

The hash code.