Struct Code

pub struct Code {
    pub value: RefCell<String>,
    pub start_line_number: NonZeroU64,
    pub source: Rc<Source>,
}

Source code fragment

An instance of Code contains a block of the source code that was parsed to produce an AST.

Fields

value: RefCell<String>

Content of the code, usually terminated by a newline

The value is contained in a RefCell so that more lines can be appended to the value as the parser reads input lines. It is not intended to be mutably borrowed for other purposes.

start_line_number: NonZeroU64

Line number of the first line of the code. Counted from 1.

source: Rc<Source>

Origin of this code

Implementations

impl Code

pub fn line_number(&self, char_index: usize) -> NonZeroU64

Computes the line number of the character at the given index.

The index should be between 0 and self.value.borrow().chars().count(). The return value is self.start_line_number plus the number of newlines in self.value up to the character at char_index. If char_index is out of bounds, the return value is for the last character.

This function will panic if self.value has been mutually borrowed.

Trait Implementations

impl Clone for Code

fn clone(&self) -> Code

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Code

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

Formats the value using the given formatter.

impl PartialEq for Code

fn eq(&self, other: &Code) -> 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 Code

impl StructuralPartialEq for Code