Enum ProjectionKey 

#[non_exhaustive]
pub enum ProjectionKey {
    Typed(String),
    Resolved(String),
}

What a projection curve may be keyed under.

A projection key is a string in the rate-index namespace. It reaches MarketContext::with_projection_checked two ways, and they warrant different treatment:

• A code a caller typed is where a typo enters. It is checked against the registry, and an unknown one is refused naming the registered set.
• An index value has already established what it is. There is no typo to catch, so it is taken at its word and keyed under the name a leg on that index would carry. This is what lets a caller pin a curve for an index they built rather than resolved, without registering it first.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Typed(String)

A string naming an index, to be checked against the registry.

Resolved(String)

The key of an index that is already in hand.

Implementations

impl ProjectionKey

pub fn as_str(&self) -> &str

The string this key stores under.

Trait Implementations

impl Clone for ProjectionKey

fn clone(&self) -> ProjectionKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectionKey

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

Formats the value using the given formatter.

impl Eq for ProjectionKey

impl From<&AnyIndex> for ProjectionKey

fn from(i: &AnyIndex) -> Self

Converts to this type from the input type.

impl From<&IborIndex> for ProjectionKey

fn from(i: &IborIndex) -> Self

Converts to this type from the input type.

impl From<&OvernightIndex> for ProjectionKey

fn from(i: &OvernightIndex) -> Self

Converts to this type from the input type.

impl From<&str> for ProjectionKey

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for ProjectionKey

fn from(s: String) -> Self

Converts to this type from the input type.

impl PartialEq for ProjectionKey

fn eq(&self, other: &ProjectionKey) -> 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 StructuralPartialEq for ProjectionKey