Enum FundField 

#[non_exhaustive]
pub enum FundField {
    Ticker,
    CompanyShortName,
    EodPrice,
    IntradayPriceChange,
    IntradayPrice,
    CategoryName,
    PerformanceRating,
    InitialInvestment,
    AnnualReturnRank,
    RiskRating,
    Exchange,
}

Typed field names for mutual fund custom screener queries.

Use with FundScreenerQuery and ScreenerFieldExt.

Example

use finance_query::{FundField, FundScreenerQuery, ScreenerFieldExt};

let query = FundScreenerQuery::new()
    .sort_by(FundField::PerformanceRating, false)
    .add_condition(FundField::RiskRating.lte(3.0))
    .include_fields(vec![
        FundField::Ticker,
        FundField::CompanyShortName,
        FundField::IntradayPrice,
        FundField::PerformanceRating,
    ]);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Ticker

Ticker symbol — display only, use in include_fields.

CompanyShortName

Short company name — display only, use in include_fields.

EodPrice

End-of-day price ("eodprice").

IntradayPriceChange

Intraday price change ("intradaypricechange").

IntradayPrice

Intraday price ("intradayprice").

CategoryName

Fund category name ("categoryname").

PerformanceRating

Overall performance rating ("performanceratingoverall").

InitialInvestment

Minimum initial investment ("initialinvestment").

AnnualReturnRank

Annual return rank within category ("annualreturnnavy1categoryrank").

RiskRating

Overall risk rating ("riskratingoverall").

Exchange

Exchange ("exchange").

Implementations

impl FundField

pub fn as_str(&self) -> &'static str

Returns the Yahoo Finance API field name string for this variant.

pub fn all() -> &'static [FundField]

Returns a slice of all FundField variants.

Trait Implementations

impl Clone for FundField

fn clone(&self) -> FundField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FundField

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

Formats the value using the given formatter.

impl FromStr for FundField

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for FundField

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FundField

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

fn as_str(&self) -> &'static str

Returns the Yahoo Finance API field name string.

impl Serialize for FundField

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Copy for FundField

impl Eq for FundField

impl StructuralPartialEq for FundField