Struct StockScreener 

pub struct StockScreener { /* private fields */ }

Stock screener with asset-class defaults

Implementations

impl StockScreener

pub fn new() -> Self

Creates a screener with default stock fields, America market, and market-cap sort.

pub fn set_markets( &mut self, markets: impl IntoIterator<Item = Market>, ) -> &mut Self

Sets market filters

pub fn set_symbol_types( &mut self, symbol_types: impl IntoIterator<Item = impl AsRef<str>>, ) -> Result<&mut Self>

Adds stock type and subtype filters

Errors

Returns TvscreenerError::InvalidRequest when a symbol type is unknown or has no type mapping.

impl StockScreener

pub const fn inner(&self) -> &Screener

Immutable access to the shared builder.

pub const fn inner_mut(&mut self) -> &mut Screener

Mutable access for advanced configuration.

pub async fn get(&self) -> Result<Vec<ScreenerRow>>

Runs the scan

Errors

Propagates errors from $crate::core::Screener::get.

pub fn select( &mut self, fields: impl IntoIterator<Item = FieldDef>, ) -> &mut Self

Replaces selected columns

pub fn select_all(&mut self) -> &mut Self

Reloads default columns via $crate::core::Screener::select_all.

Panics

Panics if set_all_fields_fn was not registered in new() (typed constructors always do).

pub fn search(&mut self, value: impl Into<String>) -> Result<&mut Self>

Adds a name/description search filter.

Errors

Propagates $crate::core::Screener::search errors.

pub const fn set_range(&mut self, from_range: u32, to_range: u32) -> &mut Self

Sets the result window

pub fn where_condition( &mut self, condition: FieldCondition, ) -> Result<&mut Self>

Adds a filter from a $crate::filter::FieldCondition.

Errors

Propagates $crate::core::Screener::where_condition errors.

Trait Implementations

impl Clone for StockScreener

fn clone(&self) -> StockScreener

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StockScreener

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

Formats the value using the given formatter.

impl Default for StockScreener

fn default() -> Self

Returns the “default value” for a type.