Enum rustpython_vm::function::OptionalArg

[−] Show declaration

pub enum OptionalArg<T = PyObjectRef> {
    Present(T),
    Missing,
}

[−] Expand description

An argument that may or may not be provided by the caller.

This style of argument is not possible in pure Python.

Variants

Present(T)

Missing

Methods

impl<T> OptionalArg<T>[−]

pub fn is_present(&self) -> bool[−]

Returns true if self is of variant Present.

pub fn expect_present(self) -> T where
    Self: Debug, [−]

Unwraps the value, yielding the content of Present.

Panics

Panics if the value is not Present, with a panic message including the content of self.

pub fn present(self) -> Option<T>[−]

Returns Some if self is of variant Present, and None otherwise.

pub fn is_missing(&self) -> bool[−]

Returns true if self is of variant Missing.

impl<T> OptionalArg<T>[−]

pub fn from_option(option: Option<T>) -> Self

pub fn into_option(self) -> Option<T>

pub fn as_option(&self) -> Option<&T>

pub fn as_option_mut(&mut self) -> Option<&mut T>

pub fn as_ref(&self) -> OptionalArg<&T>

pub fn as_mut(&mut self) -> OptionalArg<&mut T>

pub fn expect(self, msg: &str) -> T

pub fn unwrap(self) -> T

pub fn unwrap_or(self, default: T) -> T

pub fn unwrap_or_else<F: FnOnce() -> T>(self, f: F) -> T

pub fn map<U, F: FnOnce(T) -> U>(self, f: F) -> OptionalArg<U>

pub fn map_or<U, F: FnOnce(T) -> U>(self, default: U, f: F) -> U

pub fn map_or_else<U, D: FnOnce() -> U, F: FnOnce(T) -> U>(
    self,
    default: D,
    f: F
) -> U

pub fn ok_or<E>(self, err: E) -> Result<T, E>

pub fn ok_or_else<E, F: FnOnce() -> E>(self, err: F) -> Result<T, E>

pub fn and<U>(self, optb: OptionalArg<U>) -> OptionalArg<U>

pub fn and_then<U, F: FnOnce(T) -> OptionalArg<U>>(self, f: F) -> OptionalArg<U>

pub fn filter<P: FnOnce(&T) -> bool>(self, predicate: P) -> Self

pub fn or(self, optb: OptionalArg<T>) -> OptionalArg<T>

pub fn or_else<F: FnOnce() -> OptionalArg<T>>(self, f: F) -> OptionalArg<T>

pub fn xor(self, optb: OptionalArg<T>) -> OptionalArg<T>

pub fn get_or_insert(&mut self, v: T) -> &mut T

pub fn get_or_insert_with<F: FnOnce() -> T>(&mut self, f: F) -> &mut T

pub fn take(&mut self) -> Self

pub fn replace(&mut self, value: T) -> Self

impl<'_, T: Copy> OptionalArg<&'_ T>[−]

pub fn copied(self) -> OptionalArg<T>

impl<'_, T: Copy> OptionalArg<&'_ mut T>[−]

pub fn copied(self) -> OptionalArg<T>

impl<'_, T: Clone> OptionalArg<&'_ T>[−]

pub fn cloned(self) -> OptionalArg<T>

impl<'_, T: Clone> OptionalArg<&'_ mut T>[−]

pub fn cloned(self) -> OptionalArg<T>

impl<T: Default> OptionalArg<T>[−]

pub fn unwrap_or_default(self) -> T

impl<T: Deref> OptionalArg<T>[−]

pub fn as_deref(&self) -> OptionalArg<&T::Target>

impl<T: DerefMut> OptionalArg<T>[−]

pub fn as_deref_mut(&mut self) -> OptionalArg<&mut T::Target>

impl<T, E> OptionalArg<Result<T, E>>[−]

pub fn transpose(self) -> Result<Option<T>, E>

Trait Implementations

impl<T: Clone> Clone for OptionalArg<T>[+]

[+] Show hidden undocumented items

fn clone(&self) -> Self[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<T: Debug> Debug for OptionalArg<T>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<T> Default for OptionalArg<T>[+]

[+] Show hidden undocumented items

fn default() -> OptionalArg<T>[−]

Returns the "default value" for a type.

impl<'a, T> From<&'a OptionalArg<T>> for OptionalArg<&'a T>[+]

[+] Show hidden undocumented items

fn from(o: &'a OptionalArg<T>) -> OptionalArg<&'a T>[−]

Performs the conversion.

impl<'a, T> From<&'a mut OptionalArg<T>> for OptionalArg<&'a mut T>[+]

[+] Show hidden undocumented items

fn from(o: &'a mut OptionalArg<T>) -> OptionalArg<&'a mut T>[−]

Performs the conversion.

impl<T> From<T> for OptionalArg<T>[+]

[+] Show hidden undocumented items

fn from(val: T) -> OptionalArg<T>[−]

Performs the conversion.

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

[+] Show hidden undocumented items

fn arity() -> RangeInclusive<usize>[−]

The range of positional arguments permitted by the function signature.

fn from_args(
    vm: &VirtualMachine,
    args: &mut PyFuncArgs
) -> Result<Self, ArgumentError>[−]

Extracts this item from the next argument(s).

impl<T> IntoIterator for OptionalArg<T>[+]

[+] Show hidden undocumented items

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<T>[−]

Creates an iterator from a value.

impl<T> OptionLike<T> for OptionalArg<T>