Class EventEnumVariant

Namespace

DatabentoDotNet.Reference

Assembly

DatabentoDotNet.Reference.dll

One code in one of the enum groups corporate_actions.list_enums reports.

public sealed record EventEnumVariant : IEquatable<EventEnumVariant>

Inheritance

object

EventEnumVariant

Implements

IEquatable<EventEnumVariant>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Port of upstream's EventEnumVariant (corporate.rs:507-514).

Code is a string and deliberately not one of the ten code carriers. Which type a variant belongs to is decided by the group name it was filed under — the dictionary key on ListEnumsAsync(CancellationToken), not by anything on the variant — so there is no type to parse it into without first knowing that key. Upstream makes the same call for the same reason, and it is what lets a group this library has never heard of round-trip intact.

Code is null for the blank entry a group may carry. 148 of the 235 groups the live endpoint returned list one — 154 entries in all — which is the evidence behind the ten carriers reading a blank as "no value" rather than as a malformed code. Description is never null in that response, and upstream types it non-optional; both are kept.

Properties

Code

The variant's code, or null for a group's blank entry.

public string? Code { get; init; }

Property Value

string

Description

What the code means.

public required string Description { get; init; }

Property Value

string