Struct databento::historical::timeseries::GetRangeParams

pub struct GetRangeParams {
    pub dataset: String,
    pub symbols: Symbols,
    pub schema: Schema,
    pub date_time_range: DateTimeRange,
    pub stype_in: SType,
    pub stype_out: SType,
    pub limit: Option<NonZeroU64>,
    pub upgrade_policy: VersionUpgradePolicy,
}

Available on crate feature historical only.

The parameters for TimeseriesClient::get_range(). Use GetRangeParams::builder() to get a builder type with all the preset defaults.

Fields

dataset: String

The dataset code.

symbols: Symbols

The symbols to filter for.

schema: Schema

The data record schema.

date_time_range: DateTimeRange

The request time range.

stype_in: SType

The symbology type of the input symbols. Defaults to RawSymbol.

stype_out: SType

The symbology type of the output symbols. Defaults to InstrumentId.

limit: Option<NonZeroU64>

The optional maximum number of records to return. Defaults to no limit.

upgrade_policy: VersionUpgradePolicy

How to decode DBN from prior versions. Defaults to upgrade.

Implementations

impl GetRangeParams

pub fn builder() -> GetRangeParamsBuilder<((), (), (), (), (), (), (), ())>

Create a builder for building GetRangeParams. On the builder, call .dataset(...), .symbols(...), .schema(...), .date_time_range(...), .stype_in(...)(optional), .stype_out(...)(optional), .limit(...)(optional), .upgrade_policy(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of GetRangeParams.

impl GetRangeParams

pub fn with_path(self, path: impl Into<PathBuf>) -> GetRangeToFileParams

Converts these parameters into a request that will be persisted to a file at path. Used in conjunction with `TimeseriesClient::get_range_to_file()``.

Trait Implementations

impl Clone for GetRangeParams

fn clone(&self) -> GetRangeParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetRangeParams

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

Formats the value using the given formatter.

impl From<GetRangeToFileParams> for GetRangeParams

fn from(value: GetRangeToFileParams) -> Self

Converts to this type from the input type.

impl PartialEq for GetRangeParams

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

impl StructuralPartialEq for GetRangeParams