Struct maturin::BuildOptions
source · [−]pub struct BuildOptions {
pub platform_tag: Option<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,
}
Expand description
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: 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
sourceimpl BuildOptions
impl BuildOptions
sourcepub fn into_build_context(
self,
release: bool,
strip: bool,
editable: bool
) -> Result<BuildContext>
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
sourceimpl Args for BuildOptions
impl Args for BuildOptions
sourceimpl Clone for BuildOptions
impl Clone for BuildOptions
sourcefn clone(&self) -> BuildOptions
fn clone(&self) -> BuildOptions
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl CommandFactory for BuildOptions
impl CommandFactory for BuildOptions
sourcefn into_app<'b>() -> Command<'b>
fn into_app<'b>() -> Command<'b>
Replaced with `CommandFactory::command
Deprecated, replaced with CommandFactory::command
sourcefn into_app_for_update<'b>() -> Command<'b>
fn into_app_for_update<'b>() -> Command<'b>
Replaced with `CommandFactory::command_for_update
Deprecated, replaced with CommandFactory::command_for_update
sourcefn command_for_update<'help>() -> App<'help>
fn command_for_update<'help>() -> App<'help>
sourceimpl Debug for BuildOptions
impl Debug for BuildOptions
sourceimpl Default for BuildOptions
impl Default for BuildOptions
sourcefn default() -> BuildOptions
fn default() -> BuildOptions
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for BuildOptions where
BuildOptions: Default,
impl<'de> Deserialize<'de> for BuildOptions where
BuildOptions: Default,
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl FromArgMatches for BuildOptions
impl FromArgMatches for BuildOptions
sourcefn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>
fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>
Instantiate Self
from ArgMatches
, parsing the arguments as needed. Read more
sourcefn update_from_arg_matches(
&mut self,
__clap_arg_matches: &ArgMatches
) -> Result<(), Error>
fn update_from_arg_matches(
&mut self,
__clap_arg_matches: &ArgMatches
) -> Result<(), Error>
Assign values from ArgMatches
to self
.
sourceimpl Parser for BuildOptions
impl Parser for BuildOptions
sourcefn parse_from<I, T>(itr: I) -> Self where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
fn parse_from<I, T>(itr: I) -> Self where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
Parse from iterator, exit on error
sourcefn try_parse_from<I, T>(itr: I) -> Result<Self, Error> where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
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.
sourcefn update_from<I, T>(&mut self, itr: I) where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
fn update_from<I, T>(&mut self, itr: I) where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
Update from iterator, exit on error
sourcefn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error> where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
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.
sourceimpl PartialEq<BuildOptions> for BuildOptions
impl PartialEq<BuildOptions> for BuildOptions
sourcefn eq(&self, other: &BuildOptions) -> bool
fn eq(&self, other: &BuildOptions) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &BuildOptions) -> bool
fn ne(&self, other: &BuildOptions) -> bool
This method tests for !=
.
sourceimpl Serialize for BuildOptions
impl Serialize for BuildOptions
impl Eq for BuildOptions
impl StructuralEq for BuildOptions
impl StructuralPartialEq for BuildOptions
Auto Trait Implementations
impl RefUnwindSafe for BuildOptions
impl Send for BuildOptions
impl Sync for BuildOptions
impl Unpin for BuildOptions
impl UnwindSafe for BuildOptions
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcepub fn equivalent(&self, key: &K) -> bool
pub fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more