Struct FuncArgs 

pub struct FuncArgs {
    pub args: Vec<PyObjectRef>,
    pub kwargs: KwArgs,
}

The FuncArgs struct is one of the most used structs when 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: KwArgs

Implementations

impl FuncArgs

pub fn new<A, K>(args: A, kwargs: K) -> Self

where A: Into<PosArgs>, K: Into<KwArgs>,

pub fn with_kwargs_names<A, KW>(args: A, kwarg_names: KW) -> Self

where A: ExactSizeIterator<Item = PyObjectRef>, KW: ExactSizeIterator<Item = String>,

pub fn from_vectorcall( args: &[PyObjectRef], nargs: usize, kwnames: Option<&[PyObjectRef]>, ) -> Self

Create FuncArgs from a vectorcall-style argument slice (PEP 590). args[..nargs] are positional, and if kwnames is provided, the last kwnames.len() entries in args[nargs..] are keyword values. Convert borrowed vectorcall args to FuncArgs (clones all values).

pub fn from_vectorcall_owned( args: Vec<PyObjectRef>, nargs: usize, kwnames: Option<&[PyObjectRef]>, ) -> Self

Convert owned vectorcall args to FuncArgs (moves values, no clone).

pub fn is_empty(&self) -> bool

pub fn prepend_arg(&mut self, item: PyObjectRef)

pub fn shift(&mut self) -> PyObjectRef

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

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

pub fn get_optional_kwarg_with_type( &self, key: &str, ty: &Py<PyType>, 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( &mut self, ) -> impl Iterator<Item = (Wtf8Buf, PyObjectRef)> + '_

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.

pub fn bind_for<T: FromArgs>( self, vm: &VirtualMachine, callee: impl Into<Callee>, ) -> PyResult<T>

Binds these arguments the way bind does, for a call whose function a failure can describe.

pub fn check_kwargs_empty( &self, vm: &VirtualMachine, ) -> Option<PyBaseExceptionRef>

pub fn check_kwargs_empty_for( &self, vm: &VirtualMachine, callee: impl Into<Callee>, ) -> Option<PyBaseExceptionRef>

The same as check_kwargs_empty, for a call whose function the message can name.

Trait Implementations

impl Clone for FuncArgs

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FuncArgs

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

Formats the value using the given formatter.

impl Default for FuncArgs

fn default() -> Self

Returns the “default value” for a type.

impl<A> From<A> for FuncArgs

where A: Into<PosArgs>,

Conversion from vector of python objects to function arguments.

fn from(args: A) -> Self

Converts to this type from the input type.

impl<Name: ArgName> From<KwArgs<PyObjectRef, Name>> for FuncArgs

fn from(kwargs: KwArgs<PyObjectRef, Name>) -> Self

Converts to this type from the input type.

impl FromArgs for FuncArgs

const PARAMS: Option<&'static [Param]>

Parameters this type contributes to a text signature.

fn from_args( _vm: &VirtualMachine, args: &mut FuncArgs, ) -> 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 Traverse for FuncArgs

fn traverse(&self, tracer_fn: &mut TraverseFn<'_>)

impl traverse() with caution! Following those guideline so traverse doesn’t cause memory error!:

fn clear(&mut self, _out: &mut Vec<PyObjectRef>)

Extract all owned child PyObjectRefs for circular reference resolution (tp_clear). Called just before object deallocation to break circular references. Default implementation does nothing.