Struct maturin::BuildOptions

pub struct BuildOptions {
    pub platform_tag: Vec<PlatformTag>,
    pub interpreter: Vec<PathBuf>,
    pub bindings: Option<String>,
    pub manifest_path: Option<PathBuf>,
    pub out: Option<PathBuf>,
    pub skip_auditwheel: bool,
    pub zig: 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: Vec<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: 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: Option<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

zig: bool

For manylinux targets, use zig to ensure compliance for the chosen manylinux version

Default to manylinux2010/manylinux_2_12 if you do not specify an --compatibility

Make sure you installed zig with pip install maturin[zig]

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

fn augment_args<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can update self.

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

fn into_app<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command

fn into_app_for_update<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command_for_update

fn command<'help>() -> App<'help>

Build a Command that can instantiate Self.

fn command_for_update<'help>() -> App<'help>

Build a Command that can update self.

impl Debug for BuildOptions

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

Formats the value using the given formatter.

impl Default for BuildOptions

fn default() -> BuildOptions

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

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut(
    __clap_arg_matches: &mut ArgMatches
) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches(
    &mut self,
    __clap_arg_matches: &ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut(
    &mut self,
    __clap_arg_matches: &mut ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for BuildOptions

fn parse() -> Self

Parse from std::env::args_os(), exit on error

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

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone, 

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error> where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone, 

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I) where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone, 

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error> where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone, 

Update from iterator, return Err on error.

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

impl StructuralEq for BuildOptions

impl StructuralPartialEq for BuildOptions