Struct VarName

pub struct VarName { /* private fields */ }

In TCL, variable references have two forms. A string like “some_var(some_index)” is the name of an array element; any other string is the name of a scalar variable. This struct is used when parsing variable references. The name is the variable name proper; the index is either None for scalar variables or Some(String) for array elements.

The Molt interp’s variable access API usually handles this automatically. Should a command need to distinguish between the two cases it can do so by using the the Value struct’s Value::as_var_name method.

Implementations

impl VarName

pub fn scalar(name: String) -> Self

Creates a scalar VarName given the variable’s name.

pub fn array(name: String, index: String) -> Self

Creates an array element VarName given the element’s variable name and index string.

pub fn name(&self) -> &str

Returns the parsed variable name.

pub fn index(&self) -> Option<&str>

Returns the parsed array index, if any.

Trait Implementations

impl Debug for VarName

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

Formats the value using the given formatter.

impl PartialEq for VarName

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for VarName

impl StructuralPartialEq for VarName