Struct python_packaging::wheel::WheelArchive

pub struct WheelArchive { /* fields omitted */ }

Represents a Python wheel archive.

Implementations

impl WheelArchive

pub fn from_reader<R>(reader: R, basename: &str) -> Result<Self> where
    R: Read + Seek, 

Construct an instance from a generic reader.

basename is the filename of the wheel. It is used to try to locate the info directory.

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

Construct an instance from a filesystem path.

pub fn archive_metadata(&self) -> Result<PythonPackageMetadata>

Obtain metadata about the wheel archive itself.

pub fn metadata(&self) -> Result<PythonPackageMetadata>

Obtain the .dist-info/METADATA content as a parsed object.

pub fn archive_metadata_header(&self, header: &str) -> Result<Cow<'_, str>>

Obtain the first header value from the archive metadata file.

pub fn archive_metadata_headers(
    &self,
    header: &str
) -> Result<Vec<Cow<'_, str>>>

Obtain values of all headers from the archive metadata file.

pub fn wheel_version(&self) -> Result<Cow<'_, str>>

Obtain the version number of the wheel specification used to build this wheel.

pub fn wheel_generator(&self) -> Result<Cow<'_, str>>

Obtain the generator of the wheel archive.

pub fn root_is_purelib(&self) -> Result<bool>

Whether Root-Is-Purelib is set.

pub fn tags(&self) -> Result<Vec<Cow<'_, str>>>

Tag values for the wheel archive.

pub fn build(&self) -> Result<Cow<'_, str>>

Build identifier for the wheel archive.

pub fn install_paths_to(&self) -> Result<Vec<Cow<'_, str>>>

Install-Paths-To values.

pub fn dist_info_files(&self) -> Vec<File>

Obtain files in the .dist-info/ directory.

The returned PathBuf are prefixed with the appropriate *.dist-info directory.

pub fn purelib_files(&self) -> Vec<File>

Obtain files that should be installed to purelib.

*.data/purelib/ prefix is stripped from returned PathBuf.

pub fn platlib_files(&self) -> Vec<File>

Obtain files that should be installed to platlib.

*.data/platlib/ prefix is stripped from returned PathBuf.

pub fn headers_files(&self) -> Vec<File>

Obtain files that should be installed to headers.

*.data/headers/ prefix is stripped from returned PathBuf.

pub fn scripts_files(&self) -> Vec<File>

Obtain files that should be installed to scripts.

*.data/scripts/ prefix is stripped from returned PathBuf.

TODO support optional argument to rewrite #!python shebangs.

pub fn data_files(&self) -> Vec<File>

Obtain files that should be installed to data.

*.data/data/ prefix is stripped from returned PathBuf.

pub fn regular_files(&self) -> Vec<File>

Obtain normal files not part of metadata or special files.

These are likely installed as-is.

The returned PathBuf has the same path as the file in the wheel archive.

pub fn python_resources<'a>(
    &self,
    cache_tag: &str,
    suffixes: &PythonModuleSuffixes,
    emit_files: bool,
    classify_files: bool
) -> Result<Vec<PythonResource<'a>>>

Obtain PythonResource for files within the wheel.