Struct Tick 

pub struct Tick { /* private fields */ }

A single price tick with optional timestamp label and size.

Implementations

impl Tick

pub const fn new(kind: TickKind, price: MarketPrice) -> Tick

Creates a tick from a kind and price.

pub fn with_timestamp( self, timestamp: impl AsRef<str>, ) -> Result<Tick, TickError>

Attaches a non-empty timestamp label.

Errors

Returns [TickError::EmptyTimestamp] when the trimmed label is empty.

pub fn with_size(self, size: f64) -> Result<Tick, TickError>

Attaches a finite non-negative size.

Errors

Returns [TickError::NonFiniteSize] or [TickError::NegativeSize] when size is invalid.

pub const fn kind(&self) -> &TickKind

Returns the tick kind.

pub fn timestamp(&self) -> Option<&str>

Returns the optional timestamp label.

pub const fn price(&self) -> MarketPrice

Returns the tick price.

pub const fn size(&self) -> Option<f64>

Returns the optional size.

Trait Implementations

impl Clone for Tick

fn clone(&self) -> Tick

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tick

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

Formats the value using the given formatter.

impl PartialEq for Tick

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