Struct rustpython_vm::function::PyFuncArgs

pub struct PyFuncArgs {
    pub args: Vec<PyObjectRef>,
    pub kwargs: IndexMap<String, PyObjectRef>,
}

The PyFuncArgs struct is one of the most used structs then creating a rust function that can be called from python. It holds both positional arguments, as well as keyword arguments passed to the function.

Fields

args: Vec<PyObjectRef>

kwargs: IndexMap<String, PyObjectRef>

Methods

impl PyFuncArgs

pub fn new(args: Vec<PyObjectRef>, kwarg_names: Vec<String>) -> PyFuncArgs

pub fn insert(&self, item: PyObjectRef) -> PyFuncArgs

pub fn shift(&mut self) -> PyObjectRef

pub fn get_kwarg(&self, key: &str, default: PyObjectRef) -> PyObjectRef

pub fn get_optional_kwarg(&self, key: &str) -> Option<PyObjectRef>

pub fn get_optional_kwarg_with_type(
    &self,
    key: &str,
    ty: PyClassRef,
    vm: &VirtualMachine
) -> PyResult<Option<PyObjectRef>>

pub fn take_positional(&mut self) -> Option<PyObjectRef>

pub fn take_positional_keyword(&mut self, name: &str) -> Option<PyObjectRef>

pub fn take_keyword(&mut self, name: &str) -> Option<PyObjectRef>

pub fn remaining_keywords<'a>(
    &'a mut self
) -> impl Iterator<Item = (String, PyObjectRef)> + 'a

pub fn bind<T: FromArgs>(self, vm: &VirtualMachine) -> PyResult<T>

Binds these arguments to their respective values.

If there is an insufficient number of arguments, there are leftover arguments after performing the binding, or if an argument is not of the expected type, a TypeError is raised.

If the given FromArgs includes any conversions, exceptions raised during the conversion will halt the binding and return the error.

Trait Implementations

impl Clone for PyFuncArgs

fn clone(&self) -> PyFuncArgs

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PyFuncArgs

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

Formats the value using the given formatter.

impl Default for PyFuncArgs

fn default() -> PyFuncArgs

Returns the "default value" for a type.

impl<'_, '_> From<(&'_ Args<Rc<PyObject<dyn PyObjectPayload + 'static>>>, &'_ KwArgs<Rc<PyObject<dyn PyObjectPayload + 'static>>>)> for PyFuncArgs

fn from(arg: (&Args, &KwArgs)) -> Self

Performs the conversion.

impl From<Rc<PyObject<dyn PyObjectPayload + 'static>>> for PyFuncArgs

fn from(arg: PyObjectRef) -> Self

Performs the conversion.

impl From<Vec<Rc<PyObject<dyn PyObjectPayload + 'static>>>> for PyFuncArgs

Conversion from vector of python objects to function arguments.

fn from(args: Vec<PyObjectRef>) -> Self

Performs the conversion.

impl FromArgs for PyFuncArgs

fn from_args(
    _vm: &VirtualMachine,
    args: &mut PyFuncArgs
) -> Result<Self, ArgumentError>

Extracts this item from the next argument(s).

fn arity() -> RangeInclusive<usize>

The range of positional arguments permitted by the function signature.

impl<F> IntoPyNativeFunc<PyFuncArgs, Result<Rc<PyObject<dyn PyObjectPayload + 'static>>, PyRef<PyBaseException>>, VirtualMachine> for F where
    F: Fn(&VirtualMachine, PyFuncArgs) -> PyResult + 'static, 

fn into_func(self) -> PyNativeFunc