Struct OoxmlContainer 

pub struct OoxmlContainer { /* private fields */ }

OOXML container abstraction over a ZIP archive.

Provides methods to read XML files, binary data, and relationships from an Office Open XML document.

Implementations

impl OoxmlContainer

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

Open an OOXML container from a file path.

Example

use undoc::container::OoxmlContainer;

let container = OoxmlContainer::open("document.docx")?;

pub fn from_bytes(data: Vec<u8>) -> Result<Self>

Create an OOXML container from a byte vector.

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

Create an OOXML container from a reader.

pub fn read_xml(&self, path: &str) -> Result<String>

Read an XML file from the archive as a string.

Handles different encodings:

• UTF-8 (with or without BOM)
• UTF-16 LE (with BOM: FF FE)
• UTF-16 BE (with BOM: FE FF)

pub fn read_xml_optional(&self, path: &str) -> Result<Option<String>>

Read an optional XML part.

Returns Ok(None) when the part is absent (Error::MissingComponent), but surfaces any other error — including Error::Encoding for malformed byte content — so that corrupted optional parts are never silently degraded into a valid-empty result.

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

Read a binary file from the archive.

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

Check if a file exists in the archive.

pub fn list_files(&self) -> Vec<String>

List all files in the archive.

pub fn list_files_with_prefix(&self, prefix: &str) -> Vec<String>

List files matching a prefix.

pub fn read_relationships(&self, part_path: &str) -> Result<Relationships>

Read and parse relationships from a .rels file.

Legacy helper: treats missing relationship parts as optional.

pub fn read_required_relationships_for_part( &self, part_path: &str, ) -> Result<Relationships>

Read relationships for a required OOXML part.

pub fn read_optional_relationships_for_part( &self, part_path: &str, ) -> Result<Relationships>

Read relationships for an optional OOXML part.

pub fn read_package_relationships(&self) -> Result<Relationships>

Read package-level relationships (_rels/.rels).

pub fn parse_core_metadata(&self) -> Result<Metadata>

Parse core metadata from docProps/core.xml.

This is common to all OOXML formats (DOCX, XLSX, PPTX).

pub fn resolve_path(base: &str, relative: &str) -> String

Resolve a relative path from a base path.

Trait Implementations

impl Debug for OoxmlContainer

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

Formats the value using the given formatter.