Struct rustpython_vm::function::KwArgs

[+] Show declaration

pub struct KwArgs<T = PyObjectRef>(_);

[−] Expand description

A map of keyword arguments to their values.

A built-in function with a KwArgs parameter is analagous to a Python function with **kwargs. All remaining keyword arguments are extracted (and hence the function will permit an arbitrary number of them).

KwArgs optionally accepts a generic type parameter to allow type checks or conversions of each argument.

Note:

KwArgs is only for functions that accept arbitrary keyword arguments. For functions that accept only specific named arguments, a rust struct with an appropriate FromArgs implementation must be created.

Methods

impl<T> KwArgs<T>[−]

pub fn pop_kwarg(&mut self, name: &str) -> Option<T>

Trait Implementations

impl<T> FromArgs for KwArgs<T> where
    T: TryFromObject, [+]

[+] Show hidden undocumented items

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<T> IntoIterator for KwArgs<T>[+]

[+] Show hidden undocumented items

type Item = (String, T)

The type of the elements being iterated over.

type IntoIter = IntoIter<String, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter[−]

Creates an iterator from a value.