Struct pyo3_pack::BuildOptions

pub struct BuildOptions {
    pub manylinux: Manylinux,
    pub interpreter: Vec<String>,
    pub bindings: Option<String>,
    pub manifest_path: PathBuf,
    pub out: Option<PathBuf>,
    pub skip_auditwheel: bool,
    pub target: Option<String>,
    pub cargo_extra_args: Vec<String>,
    pub rustc_extra_args: Vec<String>,
}

High level API for building wheels from a crate which is also used for the CLI

Fields

manylinux: Manylinux

Control the platform tag on linux.

• 1: Use the manylinux1 tag and check for compliance{n}
• 1-unchecked: Use the manylinux1 tag without checking for compliance{n}
• 2010: Use the manylinux2010 tag and check for compliance{n}
• 2010-unchecked: Use the manylinux1 tag without checking for compliance{n}
• off: Use the native linux tag (off)

This option is ignored on all non-linux platforms

interpreter: Vec<String>

The python versions to build wheels for, given as the names of the interpreters. Uses autodiscovery if not explicitly set.

bindings: Option<String>

Which kind of bindings to use. Possible values are pyo3, rust-cpython, cffi and bin

manifest_path: PathBuf

The path to the Cargo.toml

out: Option<PathBuf>

The directory to store the built wheels in. Defaults to a new "wheels" directory in the project's target directory

skip_auditwheel: bool

[deprecated, use --manylinux instead] Don't check for manylinux compliance

target: Option<String>

The --target option for cargo

cargo_extra_args: Vec<String>

Extra arguments that will be passed to cargo as cargo rustc [...] [arg1] [arg2] --

Use as --cargo-extra-args="--my-arg"

rustc_extra_args: Vec<String>

Extra arguments that will be passed to rustc as cargo rustc [...] -- [arg1] [arg2]

Use as --rustc-extra-args="--my-arg"

Methods

impl BuildOptions

pub fn into_build_context(
    self,
    release: bool,
    strip: bool
) -> Result<BuildContext, Error>

Tries to fill the missing metadata for a BuildContext by querying cargo and python

Trait Implementations

impl Default for BuildOptions

fn default() -> Self

Returns the "default value" for a type.

impl Clone for BuildOptions

fn clone(&self) -> BuildOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Eq for BuildOptions

impl PartialEq<BuildOptions> for BuildOptions

fn eq(&self, other: &BuildOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BuildOptions) -> bool

This method tests for !=.

impl Debug for BuildOptions

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BuildOptions where
    BuildOptions: Default, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for BuildOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructOpt for BuildOptions

fn clap<'a, 'b>() -> App<'a, 'b>

Returns the corresponding clap::App.

fn from_clap(matches: &ArgMatches) -> Self

Creates the struct from clap::ArgMatches. It cannot fail with a parameter generated by clap by construction.

fn from_args() -> Self

Gets the struct from the command line arguments. Print the error message and quit the program in case of failure.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.