Struct FundamentalRegistryEntry 

pub struct FundamentalRegistryEntry {
    pub fund_id: Ustr,
    pub script_id: Ustr,
    pub script_version: Ustr,
    pub script_name: Ustr,
    pub financial_period: Option<FinancialPeriod>,
    pub fundamental_category: Option<Ustr>,
    pub short_description: Option<Ustr>,
}

A single fundamental Pine study metric registered in TradingView’s catalog.

Each fundamental indicator corresponds to a built-in Pine Script study that computes a fundamental financial metric (e.g., Total Revenue, Net Income, Debt to Equity) for a particular reporting period.

Fields

fund_id: Ustr

Canonical TradingView metric identifier (e.g., "total_revenue_fy", "ebitda_ttm").

script_id: Ustr

Pine study identifier part (e.g., "STD;Total_Revenue_FY").

script_version: Ustr

Pine study version string (e.g., "1.0" or "4").

script_name: Ustr

Human-readable study title (e.g., "Total Revenue").

financial_period: Option<FinancialPeriod>

Reporting period, if applicable (FY, FQ, FH, TTM, NOAGG, etc.).

fundamental_category: Option<Ustr>

High-level fundamental accounting category (e.g., "income_statement").

short_description: Option<Ustr>

Brief textual description of the metric.

Implementations

impl FundamentalRegistryEntry

pub fn from_pine_info(info: PineInfo) -> Option<Self>

Attempts to create a FundamentalRegistryEntry from a raw PineInfo.

Returns None if info.extra.is_fundamental_study is false or if info.extra.fund_id is missing.

pub fn fund_id(&self) -> &str

Returns the fundamental metric identifier as a string slice.

pub fn script_id(&self) -> &str

Returns the Pine Script study identifier part as a string slice.

pub fn script_version(&self) -> &str

Returns the Pine Script study version as a string slice.

pub fn script_name(&self) -> &str

Returns the human-readable script name as a string slice.

pub fn financial_period(&self) -> Option<&FinancialPeriod>

Returns the financial period, if present.

pub fn fundamental_category(&self) -> Option<&str>

Returns the accounting category, if present.

pub fn short_description(&self) -> Option<&str>

Returns the short description, if present.

pub fn base_metric(&self) -> &str

Derives the base metric name by stripping known period suffixes from fund_id.

For example:

• "total_revenue_fy" -> "total_revenue"
• "net_income_fq" -> "net_income"
• "free_cash_flow_ttm" -> "free_cash_flow"
• "shares_outstanding_noagg" -> "shares_outstanding"
• "pe_ratio" -> "pe_ratio"

pub fn to_study_options(&self) -> StudyOptions

Converts this entry into a chart StudyOptions configuration.

Note: Fundamental studies use ScriptType::IntervalScript on TradingView’s WebSocket data feed.

pub async fn fetch_indicator( &self, user: Option<&UserCookies>, ) -> Result<PineIndicator>

Asynchronously fetches the full Pine indicator metadata, returning a PineIndicator.

The resulting PineIndicator can be directly passed into chart study configurations.

Trait Implementations

impl Clone for FundamentalRegistryEntry

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FundamentalRegistryEntry

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FundamentalRegistryEntry

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FundamentalRegistryEntry

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

Formats the value using the given formatter.

impl Eq for FundamentalRegistryEntry

impl Ord for FundamentalRegistryEntry

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for FundamentalRegistryEntry

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for FundamentalRegistryEntry

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for FundamentalRegistryEntry

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FundamentalRegistryEntry

impl TryFrom<PineInfo> for FundamentalRegistryEntry

type Error = Error

The type returned in the event of a conversion error.

fn try_from(info: PineInfo) -> Result<Self>

Performs the conversion.