Skip to content

Commit

Permalink
DOC: Document no ts_out support with rec enums
Browse files Browse the repository at this point in the history
  • Loading branch information
threecgreen committed Jun 5, 2024
1 parent 98fd9ad commit 377abe9
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
4 changes: 2 additions & 2 deletions rust/dbn/src/enums.rs
Original file line number Diff line number Diff line change
Expand Up @@ -115,14 +115,14 @@ impl From<InstrumentClass> for char {
impl InstrumentClass {
/// Returns `true` if the instrument class is a type of option.
///
/// NOTE: excludes [`Self::MixedSpread`], which *may* include options.
/// Note: excludes [`Self::MixedSpread`], which *may* include options.
pub fn is_option(&self) -> bool {
matches!(self, Self::Call | Self::Put | Self::OptionSpread)
}

/// Returns `true` if the instrument class is a type of future.
///
/// NOTE: excludes [`Self::MixedSpread`], which *may* include futures.
/// Note: excludes [`Self::MixedSpread`], which *may* include futures.
pub fn is_future(&self) -> bool {
matches!(self, Self::Future | Self::FutureSpread)
}
Expand Down
7 changes: 6 additions & 1 deletion rust/dbn/src/record_enum.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ use crate::{
TradeMsg,
};

/// An owned DBN record type of flexible type.
/// An owned DBN record type of flexible type. Unlike [`RecordRef`], this type allows
/// `match`ing.
///
/// Note: this type does not support `ts_out`.
#[derive(Debug, Clone)]
pub enum RecordEnum {
/// An market-by-order message.
Expand Down Expand Up @@ -37,6 +40,8 @@ pub enum RecordEnum {

/// An immutable reference to a DBN record of flexible type. Unlike [`RecordRef`], this
/// type allows `match`ing.
///
/// Note: this type does not support `ts_out`.
#[derive(Debug, Copy, Clone)]
pub enum RecordRefEnum<'a> {
/// A reference to a market-by-order message.
Expand Down

0 comments on commit 377abe9

Please sign in to comment.