Struct maturin::BuildOptions

pub struct BuildOptions {
    pub platform_tag: Option<PlatformTag>,
    pub interpreter: Option<Vec<PathBuf>>,
    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>,
    pub universal2: bool,
}

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

Fields

platform_tag: Option<PlatformTag>

Control the platform tag on linux.

Options are manylinux tags (for example manylinux2014/manylinux_2_24) or musllinux tags (for example musllinux_1_2) and linux for the native linux tag.

Note that manylinux1 is unsupported by the rust compiler. Wheels with the native linux tag will be rejected by pypi, unless they are separately validated by auditwheel.

The default is the lowest compatible manylinux tag, or plain linux if nothing matched

This option is ignored on all non-linux platforms

interpreter: Option<Vec<PathBuf>>

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

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"

Note that maturin invokes cargo twice: Once as cargo metadata and then as cargo rustc. maturin tries to pass only the shared subset of options to cargo metadata, but this is may be a bit flaky.

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"

universal2: bool

Control whether to build universal2 wheel for macOS or not. Only applies to macOS targets, do nothing otherwise.

Implementations

impl BuildOptions

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

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

Trait Implementations

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 Debug for BuildOptions

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

Formats the value using the given formatter.

impl Default for BuildOptions

fn default() -> Self

Returns the “default value” for a type.

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 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 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 clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

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.

impl Eq for BuildOptions

impl StructuralEq for BuildOptions

impl StructuralPartialEq for BuildOptions