Struct CodeMap

pub struct CodeMap<T = DefaultFileData>
where
    T: FileData,
{ /* private fields */ }

A data structure recording source code files for position lookup.

Implementations

impl<T> CodeMap<T>

where T: FileData,

pub fn new() -> CodeMap<T>

Creates an empty CodeMap.

Examples found in repository

examples/simple.rs (line 16)

fn main() {
    let file = r#"
pub fn look_up_pos(&self, pos: Pos) -> Loc {
    let file = self.find_file(pos);
    let position = file.find_line_col(pos);
    Loc { file, position }
}
"#;

    let mut codemap = CodeMap::new();
    let file_span = codemap.add_file(DefaultFileData::new("test.rs".to_owned(), file.to_owned())).span;
    let fn_span = file_span.subspan(8, 19);
    let ret_span = file_span.subspan(40, 43);
    let var_span = file_span.subspan(54, 58);

    let sl = SpanLabel { span: fn_span, style: SpanStyle::Primary, label:Some("function name".to_owned()) };
    let sl2 = SpanLabel { span: ret_span, style: SpanStyle::Primary, label:Some("returns".to_owned()) };
    let d1 = Diagnostic { level:Level::Error, message:"Test error".to_owned(), code:Some("C000".to_owned()), spans: vec![sl, sl2] };

    let sl3 = SpanLabel { span: var_span, style: SpanStyle::Primary, label:Some("variable".to_owned()) };
    let d2 = Diagnostic { level:Level::Warning, message:"Test warning".to_owned(), code:Some("W000".to_owned()), spans: vec![sl3] };

    let d3 = Diagnostic { level: Level::Help, message:"Help message".to_owned(), code: None, spans: vec![] };

    let mut emitter = Emitter::stderr(ColorConfig::Auto, Some(&codemap));
    emitter.emit(&[d1, d2, d3]);
}

pub fn add_file(&mut self, source: T) -> Arc<File<T>>

Adds a file with the given name and contents.

Use the returned File and its .span property to create Spans representing substrings of the file.

Examples found in repository

examples/simple.rs (line 17)

fn main() {
    let file = r#"
pub fn look_up_pos(&self, pos: Pos) -> Loc {
    let file = self.find_file(pos);
    let position = file.find_line_col(pos);
    Loc { file, position }
}
"#;

    let mut codemap = CodeMap::new();
    let file_span = codemap.add_file(DefaultFileData::new("test.rs".to_owned(), file.to_owned())).span;
    let fn_span = file_span.subspan(8, 19);
    let ret_span = file_span.subspan(40, 43);
    let var_span = file_span.subspan(54, 58);

    let sl = SpanLabel { span: fn_span, style: SpanStyle::Primary, label:Some("function name".to_owned()) };
    let sl2 = SpanLabel { span: ret_span, style: SpanStyle::Primary, label:Some("returns".to_owned()) };
    let d1 = Diagnostic { level:Level::Error, message:"Test error".to_owned(), code:Some("C000".to_owned()), spans: vec![sl, sl2] };

    let sl3 = SpanLabel { span: var_span, style: SpanStyle::Primary, label:Some("variable".to_owned()) };
    let d2 = Diagnostic { level:Level::Warning, message:"Test warning".to_owned(), code:Some("W000".to_owned()), spans: vec![sl3] };

    let d3 = Diagnostic { level: Level::Help, message:"Help message".to_owned(), code: None, spans: vec![] };

    let mut emitter = Emitter::stderr(ColorConfig::Auto, Some(&codemap));
    emitter.emit(&[d1, d2, d3]);
}

pub fn find_file(&self, pos: Pos) -> &Arc<File<T>>

Looks up the File that contains the specified position.

pub fn look_up_pos(&self, pos: Pos) -> Loc<T>

Gets the file, line, and column represented by a Pos.

pub fn look_up_span(&self, span: Span) -> SpanLoc<T>

Gets the file and its line and column ranges represented by a Span.

Trait Implementations

impl<T> Debug for CodeMap<T>

where T: Debug + FileData,

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

Formats the value using the given formatter.

impl<T> Default for CodeMap<T>

where T: Default + FileData,

fn default() -> CodeMap<T>

Returns the “default value” for a type.