Enum ParamKind 

#[repr(u8)]
pub enum ParamKind {
    PositionalOnly = 0,
    Normal = 1,
    NamedOnly = 2,
    Rest = 3,
    RestMap = 4,
    RestNamed = 5,
}

How a parameter of a ParamList receives arguments.

The kinds appear in this order in a list: positional-only, normal, at most one rest (Rest or RestMap), named-only, at most one RestNamed. This is HIR’s Param kind set (specs/HIR.md §10) without the receiver, which is an ordinary positional parameter at this level.

Examples

use bytecode_lang::ParamKind;

assert_eq!(ParamKind::Normal.code(), 1);
assert_eq!(ParamKind::RestNamed.to_string(), "rest_named");
assert!(ParamKind::RestMap.is_rest());
assert!(ParamKind::NamedOnly.takes_names());
assert!(!ParamKind::PositionalOnly.takes_names());

Variants

PositionalOnly = 0

Bound by position only (Python’s parameters before /).

Normal = 1

Bound by position or by name (every PHP parameter).

NamedOnly = 2

Bound by name only (Python’s parameters after *).

Rest = 3

Collects the extra positional arguments into a new dyn array (Python *args).

RestMap = 4

Collects the extra positional arguments into a new dyn map under the keys 0, 1, ..., and, when the list has no RestNamed, the unknown named arguments under their names (PHP ...$args since 8.1).

RestNamed = 5

Collects the unknown named arguments into a new dyn map from name to value (Python **kwargs).

Implementations

impl ParamKind

pub const ALL: &'static [ParamKind]

Every value, in code order.

pub const fn from_code(code: u8) -> Option<Self>

The value with this stable code, or None if no value has it.

pub const fn code(self) -> u8

The stable code this value is encoded as.

pub const fn name(self) -> &'static str

The lowercase name the disassembler prints.

impl ParamKind

pub const fn is_rest(self) -> bool

Whether the parameter collects arguments into a new container.

Examples

use bytecode_lang::ParamKind;

assert!(ParamKind::Rest.is_rest());
assert!(!ParamKind::Normal.is_rest());

pub const fn takes_names(self) -> bool

Whether a named argument can bind to the parameter by its name.

Examples

use bytecode_lang::ParamKind;

assert!(ParamKind::Normal.takes_names());
assert!(!ParamKind::Rest.takes_names());

Trait Implementations

impl Clone for ParamKind

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ParamKind

impl Debug for ParamKind

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

Formats the value using the given formatter.

impl Display for ParamKind

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

Formats the value using the given formatter.

impl Eq for ParamKind

impl Hash for ParamKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ParamKind

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ParamKind

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for ParamKind

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ParamKind