Struct lib_ruby_parser::nodes::Sym

#[repr(C)]
pub struct Sym {
    pub name: StringValue,
    pub begin_l: MaybeLoc,
    pub end_l: MaybeLoc,
    pub expression_l: Loc,
}

Represents a plain symbol literal (i.e. :foo)

Note that : in { foo: bar } belongs to a pair node.

Fields

name: StringValue

Value of the symbol literal

Note that it’s a StringValue, not a String. The reason is that you can get UTF-8 incompatible strings from a valid UTF-8 source using escape sequences like "\xFF"

These “", “x”, “F”, “F” chars are valid separately, but together they construct a char with code = 255 that is invalid for UTF-8.

You can use to_string_lossy or to_string methods to get a raw symbol value.

begin_l: MaybeLoc

Location of the symbol begin

:foo
~

None if symbol is a label ({ foo: 1 }) or a part of the symbols array (%i[foo bar baz])

end_l: MaybeLoc

Location of the symbol end

{ 'foo': 1 }
       ~

None if symbol is not a string label (:foo) or a part of the symbols array (%i[foo bar baz])

expression_l: Loc

Location of the full expression

:foo
~~~~

{ foo: 1 }
  ~~~~

%i[foo]
   ~~~

Trait Implementations

impl Clone for Sym

fn clone(&self) -> Sym

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sym

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

Formats the value using the given formatter.

impl PartialEq<Sym> for Sym

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Sym