Struct Frame

pub struct Frame {
    pub name: String,
    pub span: TextSpan,
    pub path: String,
}

A frame represents a single function call.

It provides info of which function is being executed. This helps in debugging and error reporting.

Fields

name: String

The name of the function being executed.

span: TextSpan

The span of the function in the source code.

path: String

The path of the file where the function is defined.

Implementations

impl Frame

pub fn new( name: impl Into<String>, span: TextSpan, path: impl Into<String>, ) -> Self

Creates a new Frame with the specified name, span, and path.

Parameters

• name - The name of the function.
• span - The span of the function in the source code.
• path - The path of the file where the function is defined.

Returns

The new Frame.

Examples

use roan_error::{Position, TextSpan};
use roan_error::frame::Frame;
let frame = Frame::new("main", TextSpan::new(Position::new(1,1,1), Position::new(1,1,1), "main".into()), ".\\src\\main.roan");

pub fn path_or_unknown(path: Option<PathBuf>) -> String

If path is None returns “unknown” otherwise returns the path.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.