Struct AltiumDocument 

pub struct AltiumDocument<R: Read + Seek> { /* private fields */ }

Unified entry point for working with Altium files.

Provides ergonomic access to any Altium file type through a common interface, with methods for accessing different abstraction layers.

Implementations

impl AltiumDocument<File>

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Opens a file by path.

impl<R: Read + Seek> AltiumDocument<R>

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

Opens from a reader.

pub fn cfb(&mut self) -> &mut AltiumCfb<R>

Returns the CFB wrapper for low-level operations.

pub fn file_type(&self) -> AltiumFileType

Returns the detected file type.

pub fn params(&mut self, stream_path: &str) -> Result<&ParamsContainer>

Gets records from a stream as a parameter container.

Loads and caches the container on first access.

pub fn params_mut(&mut self, stream_path: &str) -> Result<&mut ParamsContainer>

Gets mutable records from a stream.

pub fn binary(&mut self, stream_path: &str) -> Result<&BinaryContainer>

Gets binary records from a stream.

pub fn binary_mut(&mut self, stream_path: &str) -> Result<&mut BinaryContainer>

Gets mutable binary records from a stream.

pub fn component_names(&mut self) -> Result<Vec<String>>

For libraries: lists component/footprint names.

pub fn resolve_component(&mut self, name: &str) -> Result<String>

Resolves a component name to its storage path.

pub fn clear_cache(&mut self)

Clears all cached containers.