Struct KwArgs

pub struct KwArgs<T = PyObjectRef>(/* private fields */);

A map of keyword arguments to their values.

A built-in function with a KwArgs parameter is analogous 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.

Implementations

impl<T> KwArgs<T>

pub fn new(map: IndexMap<String, T>) -> Self

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

pub fn is_empty(self) -> bool

Trait Implementations

impl<T: Clone> Clone for KwArgs<T>

fn clone(&self) -> KwArgs<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Default for KwArgs<T>

fn default() -> Self

Returns the “default value” for a type.

impl From<KwArgs> for FuncArgs

fn from(kwargs: KwArgs) -> Self

Converts to this type from the input type.

impl<T> FromArgs for KwArgs<T>

where T: TryFromObject,

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<T> FromIterator<(String, T)> for KwArgs<T>

fn from_iter<I: IntoIterator<Item = (String, T)>>(iter: I) -> Self

Creates a value from an iterator.

impl<T> IntoIterator for KwArgs<T>

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.

impl<T> Traverse for KwArgs<T>

where T: Traverse,

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

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