Skip to main content

FixingKey

Enum FixingKey 

#[non_exhaustive]
pub enum FixingKey { Typed(String), Resolved(String), }
Expand description

What an observation may be keyed under.

A fixing key is a string in the rate-index namespace — the same namespace a projection curve is keyed by, and it reaches FixingStore::from_observations_checked the same two ways the market’s ProjectionKey distinguishes:

  • A code a caller typed is where a typo enters. It is checked against the registry, and one that is not a registered code in its registered casing is refused naming the registered set. The casing matters here in a way a resolving lookup forgives: the store matches its keys literally, so a spelling the registry would resolve but no coupon carries is still a key nothing will ever read.
  • An index value has already established what it is. There is no typo to catch, so no lookup happens and the observation is stored under the name a leg on that index would carry. This is what lets a caller publish fixings for an index they built rather than resolved, without registering it first.

Variants (Non-exhaustive)§

This enum is marked as 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 FixingKey

pub fn as_str(&self) -> &str

The string this key stores under.

Trait Implementations§

§

impl Clone for FixingKey

§

fn clone(&self) -> FixingKey

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for FixingKey

§

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

Formats the value using the given formatter. Read more
§

impl Eq for FixingKey

§

impl From<&AnyIndex> for FixingKey

§

fn from(i: &AnyIndex) -> Self

Converts to this type from the input type.
§

impl From<&IborIndex> for FixingKey

§

fn from(i: &IborIndex) -> Self

Converts to this type from the input type.
§

impl From<&OvernightIndex> for FixingKey

§

fn from(i: &OvernightIndex) -> Self

Converts to this type from the input type.
§

impl From<&SwapIndex> for FixingKey

§

fn from(index: &SwapIndex) -> Self

The index in hand: its prints are stored under SwapIndex::code.

§

impl From<&str> for FixingKey

§

fn from(s: &str) -> Self

Converts to this type from the input type.
§

impl From<String> for FixingKey

§

fn from(s: String) -> Self

Converts to this type from the input type.
§

impl PartialEq for FixingKey

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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 FixingKey

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.