Struct HistoryRequest 

pub struct HistoryRequest { /* private fields */ }

Historical-bar request parameters.

Construct this request with HistoryRequest::builder. The builder starts with one unit per bar, the provider maximum of 20,000 bars, and partial bars excluded; each default can be overridden explicitly.

Implementations

impl HistoryRequest

pub fn builder( contract_id: ContractId, live: bool, start_time: Timestamp, end_time: Timestamp, unit: BarUnit, ) -> HistoryRequestBuilder

Starts a validated historical-bar request.

pub const fn contract_id(&self) -> &ContractId

Borrows the provider contract.

pub const fn is_live(&self) -> bool

Returns whether the live-data subscription is selected.

pub const fn start_time(&self) -> Timestamp

Returns the absolute range start.

pub const fn end_time(&self) -> Timestamp

Returns the absolute range end.

pub const fn unit(&self) -> BarUnit

Returns the aggregation unit.

pub const fn unit_number(&self) -> i32

Returns the positive number of units per bar.

pub const fn limit(&self) -> i32

Returns the requested bar limit in 1..=20_000.

pub const fn includes_partial_bar(&self) -> bool

Returns whether the current partial bar is requested.

Trait Implementations

impl Clone for HistoryRequest

fn clone(&self) -> HistoryRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HistoryRequest

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

Formats the value using the given formatter.

impl Eq for HistoryRequest

impl PartialEq for HistoryRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for HistoryRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HistoryRequest