Struct maturin::BuildOptions

pub struct BuildOptions {
    pub platform_tag: Vec<PlatformTag>,
    pub interpreter: Vec<PathBuf>,
    pub find_interpreter: bool,
    pub bindings: Option<String>,
    pub out: Option<PathBuf>,
    pub skip_auditwheel: bool,
    pub zig: bool,
    pub universal2: bool,
    pub cargo: CargoOptions,
}

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 and manylinux2010 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.

find_interpreter: bool

Find interpreters from the host machine

bindings: Option<String>

Which kind of bindings to use.

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 manylinux2014/manylinux_2_17 if you do not specify an --compatibility

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

universal2: bool

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

cargo: CargoOptions

Cargo build options

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

Methods from Deref<Target = CargoOptions>

pub fn merge_with_pyproject_toml(
    &mut self,
    tool_maturin: ToolMaturin
) -> Vec<&'static str>

Merge options from pyproject.toml

Trait Implementations

impl Args for BuildOptions

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

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

Append to Command so it can instantiate Self.

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

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 command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

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

type Target = CargoOptions

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for BuildOptions

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for BuildOptionswhere
    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<RichFormatter>>

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

fn parse_from<I, T>(itr: I) -> Selfwhere
    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<RichFormatter>>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<RichFormatter>>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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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