Struct Package 

pub struct Package { /* private fields */ }

The raw package: parts, content types, relationships.

Implementations

impl Package

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

Opens a package file with positioned reads.

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

Opens a package held in memory.

pub fn from_source(source: Arc<dyn Source>) -> Result<Self>

Opens a package over any positioned source.

pub fn from_archive(archive: Archive) -> Result<Self>

pub fn seed(&self) -> PackageSeed

A handle that can cross threads; see Package::from_seed.

pub fn from_seed(seed: PackageSeed) -> Self

A package sharing the archive and parsed directory of seed, with its own caches.

pub fn archive(&self) -> &Archive

pub fn parts(&self) -> &[Part]

Every part in archive order.

pub fn content_types(&self) -> &ContentTypes

pub fn defects(&self) -> &PackageDefects

pub fn part_index(&self, name: &str) -> Option<usize>

The index of the part named name, compared ASCII case-insensitively.

pub fn has_part(&self, name: &str) -> bool

pub fn part(&self, name: &str) -> Option<&Part>

The part as written, found case-insensitively.

pub fn entry(&self, name: &str) -> Option<&Entry>

The archive entry backing name.

pub fn content_type_of(&self, name: &str) -> Option<&str>

The declared content type of name (7.2.3.5).

pub fn read_part(&self, name: &str) -> Result<Rc<Vec<u8>>>

The decompressed bytes of a part, cached for the life of this package.

pub fn read_part_into(&self, name: &str, out: &mut Vec<u8>) -> Result<()>

The decompressed bytes of a part into out, bypassing the cache. Interleaved pieces are concatenated; a UTF-16 XML part comes back as UTF-8.

pub fn read_part_bytes(&self, name: &str, out: &mut Vec<u8>) -> Result<()>

The decompressed bytes of a part exactly as stored (pieces concatenated), without the UTF-16 transcoding of Package::read_part.

pub fn rels(&self, source: &str) -> Result<Rc<Relationships>>

The relationships of source (/ for the package). A missing Relationships part yields an empty set; a malformed one is an error.

pub fn package_rels(&self) -> Result<Rc<Relationships>>

pub fn resolve(&self, source: &str, id: &str) -> Result<Option<String>>

The part name relationship id of source points at, when internal.