Struct Param 

pub struct Param {
    pub name: Option<StrId>,
    pub kind: ParamKind,
    pub by_ref: bool,
    pub default: bool,
}

One parameter of a ParamList.

Examples

use bytecode_lang::{Param, ParamKind, StrId};

let p = Param::normal(StrId(3)).by_ref();
assert_eq!((p.kind, p.name, p.by_ref, p.default), (ParamKind::Normal, Some(StrId(3)), true, false));

Fields

name: Option<StrId>

The parameter’s name in the callee’s module. Required for Normal and NamedOnly parameters; optional (diagnostics only) for the others.

kind: ParamKind

How the parameter receives arguments.

by_ref: bool

Whether the parameter takes its argument by reference (PHP &$x): it receives a reference (kind reference) aliasing the caller’s place instead of the value. For a rest parameter, every collected argument is taken by reference.

default: bool

Whether the parameter has a default, which the callee computes itself when the presence mask says no argument arrived. Never set on a rest parameter.

Implementations

impl Param

pub const fn new(kind: ParamKind, name: Option<StrId>) -> Self

A parameter of kind kind named name, by value, without default.

Examples

use bytecode_lang::{Param, ParamKind};

assert_eq!(Param::new(ParamKind::Rest, None).kind, ParamKind::Rest);

pub const fn normal(name: StrId) -> Self

A Normal parameter named name.

Examples

use bytecode_lang::{Param, ParamKind, StrId};

assert_eq!(Param::normal(StrId(0)).kind, ParamKind::Normal);

pub const fn by_ref(self) -> Self

This parameter taking its argument by reference.

Examples

use bytecode_lang::{Param, StrId};

assert!(Param::normal(StrId(0)).by_ref().by_ref);

pub const fn with_default(self) -> Self

This parameter with a default.

Examples

use bytecode_lang::{Param, StrId};

assert!(Param::normal(StrId(0)).with_default().default);

Trait Implementations

impl Clone for Param

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 Param

impl Debug for Param

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

Formats the value using the given formatter.

impl Eq for Param

impl Hash for Param

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 Param

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 Param

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Param

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 Param