Structsยง
- Dict
Varkeywords - Marker struct which indicates unknown keywords should be collected into a
PyDict
. - Function
Description - Function argument specification for a
#[pyfunction]
or#[pymethod]
. - Keyword
Only Parameter Description - NoVarargs
- Marker struct which indicates varargs are not allowed.
- NoVarkeywords
- Marker struct which indicates unknown keywords are not permitted.
- Tuple
Varargs - Marker struct which indicates varargs should be collected into a
PyTuple
.
Traitsยง
- Function
Argument Holder - Trait for types which can be a function argument holder - they should to be able to const-initialize to an empty value.
- PyFunction
Argument - A trait which is used to help PyO3 macros extract function arguments.
- Varargs
Handler - A trait used to control whether to accept varargs in FunctionDescription::extract_argument_(method) functions.
- Varkeywords
Handler - A trait used to control whether to accept varkeywords in FunctionDescription::extract_argument_(method) functions.
Functionsยง
- argument_
extraction_ ๐ปerror - Adds the argument name to the error message of an error which occurred during argument extraction.
- extract_
argument ๐ป - The standard implementation of how PyO3 extracts a
#[pyfunction]
or#[pymethod]
function argument. - extract_
argument_ ๐ปwith_ default - Alternative to
extract_argument
used when the argument has a default value provided by an annotation. - extract_
optional_ ๐ปargument - Alternative to
extract_argument
used forOption<T>
arguments. This is necessary because Option<&T> does not implementPyFunctionArgument
forT: PyClass
. - extract_
pyclass_ ref - extract_
pyclass_ ref_ mut - from_
py_ ๐ปwith - Alternative to
extract_argument
used when the argument has a#[pyo3(from_py_with)]
annotation. - from_
py_ ๐ปwith_ with_ default - Alternative to
extract_argument
used when the argument has a#[pyo3(from_py_with)]
annotation and also a default value. - push_
parameter_ ๐list - unwrap_
required_ ๐ป โargument - Unwraps the Option<&PyAny> produced by the FunctionDescription
extract_arguments_
methods. They check if required methods are all provided.
Type Aliasesยง
- PyArg ๐
- Helper type used to keep implementation more concise.