Skip to main content

PriceSettings

Struct PriceSettings 

Source
pub struct PriceSettings {
Show 13 fields pub columns: Vec<usize>, pub adjust_prices: u8, pub get_adjust_info: bool, pub get_adjust_info_only: bool, pub days_without_trade: bool, pub start_date: String, pub end_date: String, pub merge_similar_symbols: bool, pub cache: bool, pub csv: bool, pub csv_headers: bool, pub csv_delimiter: String, pub period: Period,
}
Expand description

Per-call settings for get_prices (JS defaultSettings).

Fields§

§columns: Vec<usize>

Column indices to include in the output.

Maps to columnList indices. Default: [0, 2, 3, 4, 5, 6, 7, 8, 9]

§adjust_prices: u8

Price adjustment mode applied to returned data.

  • 0: No adjustment (بدون تعدیل)
  • 1: Capital increase + dividends (افزایش سرمایه + سود نقدی)
  • 2: Capital increase only (افزایش سرمایه)
§get_adjust_info: bool

If true, an adjust_info payload is appended to each ClosingPrice containing all events needed to manually re-apply price adjustment.

Default: false

§get_adjust_info_only: bool

If true, returns only the adjust_info payload without any ClosingPrice data. Implies get_adjust_info.

Default: false

§days_without_trade: bool

If true, rows with zero trades are included in the output.

Default: false

§start_date: String

Start date for price data in YYYYMMDD format (e.g., "20230101"). Only prices with dates greater than this value will be included.

Min: "20010321". Default: "20010321"

§end_date: String

End date for price data in YYYYMMDD format (e.g., "20231231"). Only prices with dates less than or equal to this value will be included. If empty, no end date filtering is applied.

start_date should be less than or equal to end_date when both are specified.

§merge_similar_symbols: bool

If true, data for similar renamed symbols is merged into a single series.

Default: true

§cache: bool

If true, downloaded data is persisted to the local cache directory.

Default: true

§csv: bool

If true, each symbol’s result is returned as a CSV string instead of a structured ClosingPrice object.

Default: false

§csv_headers: bool

If true, a header row is prepended to each CSV result. Has no effect when csv is false.

Default: true

§csv_delimiter: String

Cell delimiter character used when generating CSV results. Has no effect when csv is false.

Default: ","

§period: Period

Resampling timeframe for the returned rows. Daily (default) keeps the rows as-is; Weekly/Monthly aggregate them using the Jalali calendar.

Trait Implementations§

Source§

impl Clone for PriceSettings

Source§

fn clone(&self) -> PriceSettings

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PriceSettings

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PriceSettings

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more