Struct dbn::symbol_map::TsSymbolMap

pub struct TsSymbolMap(/* private fields */);

A timeseries symbol map. Generally useful for working with historical data and is commonly built from a Metadata object via Self::from_metadata().

Implementations

impl TsSymbolMap

pub fn new() -> Self

Creates a new timeseries symbol map.

pub fn is_empty(&self) -> bool

Returns true if there are no mappings.

pub fn len(&self) -> usize

Returns the number of symbol mappings in the map.

pub fn from_metadata(metadata: &Metadata) -> Result<Self>

Creates a new timeseries symbol map from the metadata.

Errors

This function returns an error if neither stype_in or stype_out are SType::InstrumentId. It will also return an error if it can’t parse a symbol into u32 instrument ID.

pub fn insert( &mut self, instrument_id: u32, start_date: Date, end_date: Date, symbol: Arc<String> ) -> Result<()>

Inserts a new mapping into the symbol map.

If the map already had a mapping, the mapping is updated.

Errors

This function returns an error if start_date comes after end_date.

pub fn get(&self, date: Date, instrument_id: u32) -> Option<&String>

Returns the symbol mapping for the given date and instrument ID. Returns None if no mapping exists.

pub fn inner(&self) -> &HashMap<(Date, u32), Arc<String>>

Returns a reference to the inner map.

pub fn inner_mut(&mut self) -> &mut HashMap<(Date, u32), Arc<String>>

Returns a mutable reference to the inner map.

Trait Implementations

impl Clone for TsSymbolMap

fn clone(&self) -> TsSymbolMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TsSymbolMap

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

Formats the value using the given formatter.

impl Default for TsSymbolMap

fn default() -> TsSymbolMap

Returns the “default value” for a type.

impl Index<&(Date, u32)> for TsSymbolMap

type Output = String

The returned type after indexing.

fn index(&self, index: &(Date, u32)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<R: HasRType> Index<&R> for TsSymbolMap

type Output = String

The returned type after indexing.

fn index(&self, index: &R) -> &Self::Output

Performs the indexing (container[index]) operation.

impl PartialEq for TsSymbolMap

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl SymbolIndex for TsSymbolMap

fn get_for_rec<R: Record>(&self, record: &R) -> Option<&String>

Returns the associated symbol mapping for record. Returns None if no mapping exists.

fn get_for_rec_ref(&self, rec_ref: RecordRef<'_>) -> Option<&String>

👎Deprecated since 0.13.0: The trait bound for get_for_rec was loosened to accept RecordRefs, making this function redundant

Returns the associated symbol mapping for rec_ref. Returns None if no mapping exists.

impl TryFrom<&Metadata> for TsSymbolMap

type Error = Error

The type returned in the event of a conversion error.

fn try_from(metadata: &Metadata) -> Result<Self, Error>

Performs the conversion.

impl Eq for TsSymbolMap

impl StructuralPartialEq for TsSymbolMap