Struct Label

pub struct Label { /* private fields */ }

Represents a labelled span of some source code.

Each label is meant to be used as a snippet within a larger source code. It provides a way to highlight a specific portion of the source code, and uses labels to provide additional information about the span.

Implementations

impl Label

pub fn new( source: Option<Arc<dyn Source>>, range: impl Into<SpanRange>, message: impl Into<String>, ) -> Self

Creates a new Label from the given source, range, and label.

Examples

use std::sync::Arc;
use error_snippet::{Label, Severity};

let source = Arc::new(r#"fn main() -> int {
    let a = new Testing();
    let b = a.invok();

    return 0;
}"#);

let label = Label::new(Some(source.clone()), 60..65, "could not find method 'invok'");

assert_eq!(label.message(), "could not find method 'invok'");
assert_eq!(label.severity(), None);

pub fn error( source: Option<Arc<dyn Source>>, range: impl Into<SpanRange>, label: impl Into<String>, ) -> Self

Creates a new Label from the given source, range, and label, with a severity of Severity::Error.

Examples

use std::sync::Arc;
use error_snippet::{Label, Severity};

let source = Arc::new(r#"fn main() -> int {
    let a = new Testing();
    let b = a.invok();

    return 0;
}"#);

let label = Label::error(Some(source.clone()), 60..65, "could not find method 'invok'");

assert_eq!(label.message(), "could not find method 'invok'");
assert_eq!(label.severity(), Some(Severity::Error));

pub fn warning( source: Option<Arc<dyn Source>>, range: impl Into<SpanRange>, label: impl Into<String>, ) -> Self

Creates a new Label from the given source, range, and label, with a severity of Severity::Warning.

Examples

use std::sync::Arc;
use error_snippet::{Label, Severity};

let source = Arc::new(r#"fn main() -> int {
    let a = new Testing();
    let b = a.invok();

    return 0;
}"#);

let label = Label::warning(Some(source.clone()), 60..65, "could not find method 'invok'");

assert_eq!(label.message(), "could not find method 'invok'");
assert_eq!(label.severity(), Some(Severity::Warning));

pub fn info( source: Option<Arc<dyn Source>>, range: impl Into<SpanRange>, label: impl Into<String>, ) -> Self

Creates a new Label from the given source, range, and label, with a severity of Severity::Info.

Examples

use std::sync::Arc;
use error_snippet::{Label, Severity};

let source = Arc::new(r#"fn main() -> int {
    let a = new Testing();
    let b = a.invok();

    return 0;
}"#);

let label = Label::info(Some(source.clone()), 60..65, "could not find method 'invok'");

assert_eq!(label.message(), "could not find method 'invok'");
assert_eq!(label.severity(), Some(Severity::Info));

pub fn note( source: Option<Arc<dyn Source>>, range: impl Into<SpanRange>, label: impl Into<String>, ) -> Self

Creates a new Label from the given source, range, and label, with a severity of Severity::Note.

Examples

use std::sync::Arc;
use error_snippet::{Label, Severity};

let source = Arc::new(r#"fn main() -> int {
    let a = new Testing();
    let b = a.invok();

    return 0;
}"#);

let label = Label::note(Some(source.clone()), 60..65, "could not find method 'invok'");

assert_eq!(label.message(), "could not find method 'invok'");
assert_eq!(label.severity(), Some(Severity::Note));

pub fn help( source: Option<Arc<dyn Source>>, range: impl Into<SpanRange>, label: impl Into<String>, ) -> Self

Creates a new Label from the given source, range, and label, with a severity of Severity::Help.

Examples

use std::sync::Arc;
use error_snippet::{Label, Severity};

let source = Arc::new(r#"fn main() -> int {
    let a = new Testing();
    let b = a.invok();

    return 0;
}"#);

let label = Label::help(Some(source.clone()), 60..65, "could not find method 'invok'");

assert_eq!(label.message(), "could not find method 'invok'");
assert_eq!(label.severity(), Some(Severity::Help));

pub fn message(&self) -> &str

Gets the message of the current label instance.

Examples

use std::sync::Arc;
use error_snippet::{Label, Severity};

let source = Arc::new(r#"fn main() -> int {
    let a = new Testing();
    let b = a.invok();

    return 0;
}"#);

let label = Label::new(Some(source.clone()), 60..65, "could not find method 'invok'");

assert_eq!(label.message(), "could not find method 'invok'");

pub fn range(&self) -> &SpanRange

Gets the integer span of the current label instance.

Examples

use std::sync::Arc;
use error_snippet::{Label, Severity, SpanRange};

let source = Arc::new(r#"fn main() -> int {
    let a = new Testing();
    let b = a.invok();

    return 0;
}"#);

let label = Label::new(Some(source.clone()), 60..65, "could not find method 'invok'");

assert_eq!(label.range(), &SpanRange(60..65));

pub fn source(&self) -> Option<Arc<dyn Source>>

Gets the source code of the current label instance.

Examples

use std::sync::Arc;
use error_snippet::{Label, Severity, Source, SpanRange};

let source = Arc::new(r#"fn main() -> int {
    let a = new Testing();
    let b = a.invok();

    return 0;
}"#);

let label = Label::new(Some(source.clone()), 60..65, "could not find method 'invok'");

assert_eq!(label.source().unwrap().name(), source.name());
assert_eq!(label.source().unwrap().content(), source.content());

pub fn severity(&self) -> Option<Severity>

Gets the severity of the current label instance.

Examples

use std::sync::Arc;
use error_snippet::{Label, Severity};

let source = Arc::new(r#"fn main() -> int {
    let a = new Testing();
    let b = a.invok();

    return 0;
}"#);

let label = Label::new(Some(source.clone()), 60..65, "could not find method 'invok'")
    .with_severity(Severity::Warning);

assert_eq!(label.severity(), Some(Severity::Warning));

pub fn with_severity(self, severity: Severity) -> Self

Sets the severity for the current label instance.

Examples

use std::sync::Arc;
use error_snippet::{Label, Severity};

let source = Arc::new(r#"fn main() -> int {
    let a = new Testing();
    let b = a.invok();

    return 0;
}"#);

let label = Label::new(Some(source.clone()), 60..65, "could not find method 'invok'")
    .with_severity(Severity::Warning);

assert_eq!(label.message(), "could not find method 'invok'");
assert_eq!(label.severity(), Some(Severity::Warning));

Trait Implementations

impl Clone for Label

fn clone(&self) -> Label

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Label

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

Formats the value using the given formatter.

impl PartialEq for Label

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