Struct AltiumCfb 

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

Wrapper around CFB providing Altium-specific convenience methods.

This is Layer 1 of the API, providing low-level access to the CFB container with helpers for reverse engineering and exploration.

Implementations

impl AltiumCfb<File>

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

Opens a CFB file by path.

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

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

Opens a CFB from a reader.

pub fn file_type(&self) -> AltiumFileType

Returns the detected file type.

pub fn exists(&mut self, path: &str) -> bool

Returns true if the given path exists in the CFB.

pub fn streams(&mut self) -> Result<Vec<StreamInfo>>

Lists all streams in the CFB container.

pub fn storages(&mut self) -> Result<Vec<StorageInfo>>

Lists all storages (directories) in the CFB container.

pub fn section_keys(&mut self) -> Result<&HashMap<String, String>>

Loads and caches section keys mapping (LIBREF → storage path).

Section keys map full component names to truncated storage paths, which is necessary because CFB has a 31-character limit on entry names.

pub fn resolve_section(&mut self, lib_ref: &str) -> Result<String>

Resolves a component/footprint name to its storage path.

For names ≤31 chars without ‘/’, returns the name directly. For longer names or names with ‘/’, looks up in section keys.

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

Lists all component/footprint names in a library file.

pub fn read_stream(&mut self, path: &str) -> Result<Vec<u8>>

Reads raw bytes from a stream.

pub fn read_params(&mut self, path: &str) -> Result<ParameterCollection>

Reads a stream and parses it as a single ParameterCollection.

pub fn read_blocks(&mut self, path: &str) -> Result<Vec<Block>>

Reads a stream as size-prefixed blocks.

pub fn parse_blocks(data: &[u8]) -> Result<Vec<Block>>

Parses raw data as size-prefixed blocks.

pub fn decompress(&mut self, path: &str) -> Result<Vec<u8>>

Decompresses a zlib-compressed stream.

pub fn decompress_at(&mut self, path: &str, offset: usize) -> Result<Vec<u8>>

Decompresses data starting at a given offset.

pub fn hexdump( &mut self, path: &str, offset: usize, length: usize, width: usize, ) -> Result<String>

Generates a hexdump of stream content.

pub fn find_strings( &mut self, path: &str, min_length: usize, ) -> Result<Vec<FoundString>>

Finds printable strings in a stream.

pub fn search( &mut self, pattern: &str, ignore_case: bool, ) -> Result<Vec<SearchMatch>>

Searches for a pattern across all streams.

pub fn inner(&mut self) -> &mut CompoundFile<R>

Returns mutable access to the underlying CompoundFile.

Use this for advanced operations not covered by the wrapper.

pub fn inner_ref(&self) -> &CompoundFile<R>

Returns immutable access to the underlying CompoundFile.

pub fn version(&self) -> Version

Returns the CFB format version.

pub fn entry_type(&mut self, path: &str) -> Option<bool>

Checks if a path exists and returns whether it’s a stream.

Returns Some(true) if the path is a stream, Some(false) if it’s a storage, None if the path doesn’t exist.

pub fn stream_size(&mut self, path: &str) -> Option<u64>

Returns the size of a stream, or None if the path doesn’t exist or isn’t a stream.

pub fn entries(&mut self) -> Vec<(String, bool, u64)>

Returns an iterator over all entries in the CFB, yielding (path, is_stream, size).