Struct InstanceDocument 

pub struct InstanceDocument { /* private fields */ }

Represents a complete XBRL instance document

Implementations

impl InstanceDocument

pub fn new( schema_refs: Vec<String>, contexts: HashMap<ContextId, Context>, units: HashMap<UnitId, Unit>, facts: Vec<Fact>, namespaces: HashMap<NamespacePrefix, NamespaceUri>, footnote_links: Vec<FootnoteLink>, ) -> Self

pub fn from_taxonomy( taxonomy: &TaxonomySet, namespaces: HashMap<NamespacePrefix, NamespaceUri>, instant_context: Context, duration_context: Context, units: &[Unit], ) -> Self

Create a new instance pre-wired to a known taxonomy.

• Registers all schema refs and role refs from the taxonomy
• Adds both contexts and all provided units
• Pre-populates nil facts for concepts in the presentation linkbase, preserving tuple nesting derived directly from the presentation tree
• Assigns each fact the correct unitRef based on its XSD type: monetary → first currency unit, shares → first shares unit, other numeric → first pure unit, non-numeric → no unitRef

Build the DocumentView once after this call, then fill values in-place via [set_fact_value] without rebuilding the view.

pub fn from_file(path: &Path) -> Result<Self>

Parse an XBRL instance document from the file at the given path.

Automatically extracts the <xbrli:xbrl> element if the input contains a wrapper around it.

pub fn from_reader<R>(reader: R) -> Result<Self>

where R: BufRead,

Parse an XBRL instance document from the reader.

Automatically extracts the <xbrli:xbrl> element if the input contains a wrapper around it.

pub fn from_xml_reader<R>(reader: Reader<R>) -> Result<Self>

where R: BufRead,

Parse an XBRL instance document from the XML reader.

Automatically extracts the <xbrli:xbrl> element if the input contains a wrapper around it.

pub fn validate(&self, taxonomy: &TaxonomySet) -> ValidationResult

Validate this instance against a taxonomy.

pub fn view<'a>(&self, taxonomy: &'a TaxonomySet) -> DocumentView<'a>

Convenience wrapper for DocumentView::build using this instance’s item facts.

pub fn to_file(&self, path: &Path) -> Result<()>

Serialize this instance to an XML file at the given path.

pub fn to_writer<W>(&self, writer: W) -> Result<()>

where W: Write,

Serialize this instance to an XBRL XML document using a writer.

pub fn to_xml_writer<W>(&self, writer: &mut Writer<W>) -> Result<()>

where W: Write,

Serialize this instance to an XBRL XML document using an XML writer.

pub fn add_schema_ref(&mut self, href: String)

Add a schema reference (xlink:href from a link:schemaRef element)

pub fn schema_refs(&self) -> &[String]

Get all schema references declared in the instance document.

pub fn add_role_ref(&mut self, role_uri: String)

Add a role reference URI from a roleRef element.

pub fn role_refs(&self) -> &[String]

Get all role reference URIs declared in the instance document.

pub fn add_arcrole_ref(&mut self, arcrole_uri: String)

Add an arcrole reference URI from an arcroleRef element.

pub fn arcrole_refs(&self) -> &[String]

Get all arcrole reference URIs declared in the instance document.

pub fn schema_ref_paths(&self) -> Vec<&str>

Extract relative path suffixes from schema reference URLs.

Strips the URL scheme, host, and leading /taxonomies/ segment to produce paths suitable for joining with a local taxonomy directory.

For example: http://www.xbrl.de/taxonomies/de-gcd-2020-04-01/de-gcd-2020-04-01-shell.xsd becomes de-gcd-2020-04-01/de-gcd-2020-04-01-shell.xsd.

pub fn add_context(&mut self, context: Context)

Add a context to the instance

pub fn get_context(&self, id: &str) -> Option<&Context>

Get a context by ID

pub fn add_unit(&mut self, unit: Unit)

Add a unit to the instance

pub fn get_unit(&self, id: &str) -> Option<&Unit>

Get a unit by ID

pub fn add_fact(&mut self, fact: Fact)

Add a fact to the instance

pub fn facts(&self) -> &[Fact]

Get all top-level facts.

pub fn facts_mut(&mut self) -> &mut [Fact]

Get all top-level facts mutably.

pub fn item_facts(&self) -> Vec<&ItemFact>

Get all item facts in depth-first order.

pub fn item_fact_count(&self) -> usize

Number of item facts in the instance (including nested tuple descendants).

pub fn set_fact_value(&mut self, index: usize, value: String)

Set the value of a fact by its index (from DocumentView fact_indices). Clears nil status.

Panics

Panics if index is out of bounds.

pub fn add_namespace(&mut self, prefix: NamespacePrefix, uri: NamespaceUri)

Add a namespace prefix mapping

pub fn get_namespace(&self, prefix: &str) -> Option<&str>

Get namespace URI for a prefix

pub fn namespaces(&self) -> &HashMap<NamespacePrefix, NamespaceUri>

Get all namespace prefix mappings

pub fn add_footnote_link(&mut self, footnote_link: FootnoteLink)

pub fn footnote_links(&self) -> &[FootnoteLink]

pub fn contexts(&self) -> &HashMap<ContextId, Context>

Get all contexts

pub fn units(&self) -> &HashMap<UnitId, Unit>

Get all units

Trait Implementations

impl Debug for InstanceDocument

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

Formats the value using the given formatter.

impl Default for InstanceDocument

fn default() -> InstanceDocument

Returns the “default value” for a type.