Struct OutturnStyle

Namespace

DatabentoDotNet.Reference

Assembly

DatabentoDotNet.Reference.dll

Whether an outturn security is new or additional to an existing holding.

[JsonConverter(typeof(ReferenceCodeJsonConverter<OutturnStyle>))]
public readonly record struct OutturnStyle : IReferenceCode<OutturnStyle>, IEquatable<OutturnStyle>

Implements

IReferenceCode<OutturnStyle>

IEquatable<OutturnStyle>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

An open set: a code this library does not know is carried, not lost. Upstream ends this enum in an Unknown(String) variant (enums.rs:3157) so a code Databento adds next month round-trips untouched, and a C# enum cannot hold a payload. See IReferenceCode<TSelf> for the shape this takes instead and why.

The members come from the OUTTURNSTYLE group of the vendored corporate_actions.list_enums response, which is the oracle rather than a count typed into an issue.

Exact against the live dictionary today, at two codes each, and an open carrier anyway: the rule is where a vocabulary comes from, not how many values it currently holds.

Constructors

OutturnStyle(string)

Wraps a wire code, known or not. Prefer a named member such as Adex where one exists, and From(string?) where the value came from the server.

public OutturnStyle(string code)

Parameters

code string

The wire code.

Exceptions

ArgumentException

code is null or empty. A blank code is the absence of a value, which is default.

Properties

Adex

Additional for Existing Securities (ADEX).

public static OutturnStyle Adex { get; }

Property Value

OutturnStyle

Code

The wire code, or null when this names no value.

public string? Code { get; }

Property Value

string

HasValue

true when this names a code — known or not.

public bool HasValue { get; }

Property Value

bool

IsKnown

true when Code is one of KnownCodes.

public bool IsKnown { get; }

Property Value

bool

Remarks

false is not an error. It means the server sent something newer than the table this library shipped with, and the code is still in Code to be read, logged, or sent back in a filter.

KnownCodes

Every code the reference API reported for this type when the fixture was captured — 2 of them.

public static IReadOnlySet<string> KnownCodes { get; }

Property Value

IReadOnlySet<string>

Newo

New for Old Securities (NEWO).

public static OutturnStyle Newo { get; }

Property Value

OutturnStyle

Methods

From(string?)

Reads a wire code, mapping null and the empty string to default — the absence of a value.

public static OutturnStyle From(string? code)

Parameters

code string

The wire code, or null.

Returns

OutturnStyle

The value.

ToString()

The wire code, or the empty string when this names no value.

public override string ToString()

Returns

string

The wire code.