#[non_exhaustive]pub struct CompanyFacts {
pub cik: Option<u64>,
pub entity_name: Option<String>,
pub facts: HashMap<String, FactsByTaxonomy>,
}Expand description
Complete company facts response containing all XBRL financial data.
Facts are organized by taxonomy (e.g., us-gaap, ifrs-full, dei).
Use the convenience methods to access common taxonomies.
§Example
// Get US-GAAP revenue data
if let Some(revenue) = facts.get_us_gaap_fact("Revenue") {
for (unit, values) in &revenue.units {
println!("Unit: {}, data points: {}", unit, values.len());
}
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.cik: Option<u64>CIK number
entity_name: Option<String>Company name
facts: HashMap<String, FactsByTaxonomy>Facts organized by taxonomy (e.g., “us-gaap”, “ifrs-full”, “dei”)
Implementations§
Source§impl CompanyFacts
impl CompanyFacts
Sourcepub fn us_gaap(&self) -> Option<&FactsByTaxonomy>
pub fn us_gaap(&self) -> Option<&FactsByTaxonomy>
Get US-GAAP facts (most common for US-listed companies).
Sourcepub fn get_us_gaap_fact(&self, concept: &str) -> Option<&FactConcept>
pub fn get_us_gaap_fact(&self, concept: &str) -> Option<&FactConcept>
Get a specific fact concept from the US-GAAP taxonomy.
Common concepts: "Revenue", "Assets", "Liabilities",
"NetIncomeLoss", "EarningsPerShareBasic", "StockholdersEquity".
Sourcepub fn ifrs(&self) -> Option<&FactsByTaxonomy>
pub fn ifrs(&self) -> Option<&FactsByTaxonomy>
Get IFRS facts (for companies reporting under International Financial Reporting Standards).
Sourcepub fn dei(&self) -> Option<&FactsByTaxonomy>
pub fn dei(&self) -> Option<&FactsByTaxonomy>
Get DEI (Document and Entity Information) facts.
Trait Implementations§
Source§impl Clone for CompanyFacts
impl Clone for CompanyFacts
Source§fn clone(&self) -> CompanyFacts
fn clone(&self) -> CompanyFacts
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for CompanyFacts
impl Debug for CompanyFacts
Source§impl<'de> Deserialize<'de> for CompanyFacts
impl<'de> Deserialize<'de> for CompanyFacts
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl Freeze for CompanyFacts
impl RefUnwindSafe for CompanyFacts
impl Send for CompanyFacts
impl Sync for CompanyFacts
impl Unpin for CompanyFacts
impl UnsafeUnpin for CompanyFacts
impl UnwindSafe for CompanyFacts
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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