Enum InstrumentTypeProto 

#[repr(i32)]
pub enum InstrumentTypeProto {
    InstrumentTypeUnknown = 0,
    InstrumentTypeCash = 1,
    InstrumentTypeDerivative = 2,
    InstrumentTypeReferenceIndex = 3,
}

Mechanical structure of a Security — orthogonal to productType.

Three values:

CASH A tradable underlying that settles to a position. T-Bill, common stock, BTC, FX spot, money-market fund, ETF.

DERIVATIVE A contract whose value derives from an underlying. Future, option, swap, forward, FX swap, variance swap.

REFERENCE_INDEX Observational only, never positioned. Used as fixings for derivatives or as display benchmarks. Cash-index values (.SPX, .NDX, .VIX), reference rate series (.SOFR, .CPI), and benchmark indices (Bloomberg Commodity Index).

The distinction matters because: .SPX (REFERENCE_INDEX) and SPY (CASH ETF that tracks .SPX) are both “EQUITY index”-flavoured but only SPY is positionable; ES future (DERIVATIVE) is positionable but isn’t the same instrument as either.

Enum-value names are prefixed INSTRUMENT_TYPE_* because proto3 enforces package-wide uniqueness for enum value names — bare CASH would collide with IdentifierTypeProto.CASH in this package.

Variants

InstrumentTypeUnknown = 0

InstrumentTypeCash = 1

InstrumentTypeDerivative = 2

InstrumentTypeReferenceIndex = 3

Implementations

impl InstrumentTypeProto

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of InstrumentTypeProto.

pub fn from_i32(value: i32) -> Option<InstrumentTypeProto>

Converts an i32 to a InstrumentTypeProto, or None if value is not a valid variant.

impl InstrumentTypeProto

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for InstrumentTypeProto

fn clone(&self) -> InstrumentTypeProto

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InstrumentTypeProto

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for InstrumentTypeProto

fn default() -> InstrumentTypeProto

Returns the “default value” for a type.

impl From<InstrumentTypeProto> for i32

fn from(value: InstrumentTypeProto) -> i32

Converts to this type from the input type.

impl Hash for InstrumentTypeProto

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for InstrumentTypeProto

fn cmp(&self, other: &InstrumentTypeProto) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for InstrumentTypeProto

fn eq(&self, other: &InstrumentTypeProto) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for InstrumentTypeProto

fn partial_cmp(&self, other: &InstrumentTypeProto) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for InstrumentTypeProto

impl Eq for InstrumentTypeProto

impl StructuralPartialEq for InstrumentTypeProto