Struct Diagnostics

pub struct Diagnostics { /* private fields */ }

Structure to collect compilation diagnostics.

If the project is compiled with the emit feature, you can make use of Diagnostics::emit.

Examples

use rune::{Sources, Diagnostics};
use rune::termcolor::{StandardStream, ColorChoice};

let mut sources = Sources::new();
let mut diagnostics = Diagnostics::new();

// use sources and diagnostics to compile a project.

if !diagnostics.is_empty() {
    let mut writer = StandardStream::stderr(ColorChoice::Always);
    diagnostics.emit(&mut writer, &sources)?;
}

Implementations

impl Diagnostics

pub fn emit<O>(&self, out: &mut O, sources: &Sources) -> Result<(), EmitError>

where O: WriteColor,

Available on crate feature emit only.

Generate formatted diagnostics capable of referencing source lines and hints.

See prepare for how to use.

pub fn emit_detailed<O>( &self, out: &mut O, sources: &Sources, unit: &Unit, context: &Context, ) -> Result<(), EmitError>

where O: WriteColor,

Available on crate feature emit only.

Generate formatted diagnostics capable of referencing source lines and hints.

See prepare for how to use.

impl Diagnostics

pub fn without_warnings() -> Self

Construct a new, empty collection of compilation warnings that is disabled, i.e. any warnings added to it will be ignored.

Examples

use rune::{Diagnostics, SourceId};
use rune::ast::Span;

let mut diagnostics = Diagnostics::without_warnings();
assert!(diagnostics.is_empty());

// emit warnings

assert!(diagnostics.is_empty());
let warning = diagnostics.into_diagnostics().into_iter().next();
assert!(matches!(warning, None));

pub fn new() -> Self

Construct a new, empty collection of compilation warnings.

Examples

use rune::{Diagnostics, SourceId};
use rune::ast::Span;
use rune::diagnostics::Diagnostic;

let mut diagnostics = Diagnostics::new();
assert!(diagnostics.is_empty());

pub fn is_empty(&self) -> bool

Indicate if there is any diagnostics.

pub fn has_error(&self) -> bool

Check if diagnostics has any errors reported.

pub fn has_warning(&self) -> bool

Check if diagnostics has any warnings reported.

pub fn diagnostics(&self) -> &[Diagnostic]

Access underlying diagnostics.

pub fn into_diagnostics(self) -> Vec<Diagnostic>

Convert into underlying diagnostics.

Trait Implementations

impl Debug for Diagnostics

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

Formats the value using the given formatter.

impl Default for Diagnostics

fn default() -> Self

Returns the “default value” for a type.