Skip to main content

SyncConfig

Struct SyncConfig 

Source
pub struct SyncConfig {
    pub from: i32,
    pub to: i32,
    pub include_fundamentals: bool,
    pub include_industry: bool,
    pub include_snapshot_factors: bool,
    pub skip_non_stocks: bool,
    pub min_market_cap: f64,
    pub rate_limit_per_min: u32,
    pub max_retries: u32,
    pub backoff_base: Duration,
    pub mode: WriteMode,
}
Expand description

Knobs for one [sync] run.

Fields§

§from: i32

Inclusive date bounds, packed YYYYMMDD (as everywhere else in the engine).

§to: i32§include_fundamentals: bool

Also fetch annual fundamentals → fundamentals/{SYM}.csv.gz.

§include_industry: bool

Also fetch company sector → tracked/universe.csv.gz.

§include_snapshot_factors: bool

Also compute the six snapshot-factor panels (piotroski_score, altman_z, fcf_yield, pe_industry_pctile, analyst_upside_pct, consensus_rating) → panels/{name}.csv.gz. Current-snapshot factors for universe screening (see [super::snapshot]); pe_industry_pctile ranks P/E within an industry cohort drawn from this run’s symbols.

§skip_non_stocks: bool

Skip ETFs / mutual & closed-end funds (default on) — keep only individual stocks. Classified from the profile endpoint’s isEtf / isFund.

§min_market_cap: f64

Skip symbols whose company market cap is below this, in USD (0.0 = off). Read from the profile endpoint’s marketCap. The CLI accepts unit suffixes (1b, 500m) via [parse_market_cap].

§rate_limit_per_min: u32

Max requests per minute (0 = no throttle). FMP imposes a per-plan rate limit; set this to your plan’s ceiling. Starter-class keys are commonly ~300/min — verify against your own plan.

§max_retries: u32

Retries per request on a retryable error before giving up on the symbol.

§backoff_base: Duration

Base backoff duration; the Nth retry waits base * 2^(N-1) — e.g. a 2-second base gives 2s, 4s, 8s, 16s. Duration::ZERO disables the sleep (used by tests).

§mode: WriteMode

How to treat an already-present tree.

Trait Implementations§

Source§

impl Default for SyncConfig

Source§

fn default() -> Self

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

impl RetrySettings for SyncConfig

Source§

fn rate_limit_per_min(&self) -> u32

Max requests per minute (0 = no throttle).
Source§

fn max_retries(&self) -> u32

Retries per request on a retryable error before giving up.
Source§

fn backoff_base(&self) -> Duration

Base backoff; the Nth retry waits base * 2^(N-1).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.