1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

//! Diagnostic data structures.

use std::fmt::Display;

use crate::{FileID, Span};
use serde::{Deserialize, Serialize};

#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Serialize, Deserialize)]
pub enum LabelStyle {
    /// Labels that describe the primary cause of a labels.
    Primary,
    /// Labels that provide additional context for a labels.
    Secondary,
}

/// A label describing an underlined region of code associated with a labels.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct Label {
    /// The file that we are labelling.
    pub file_id: FileID,
    /// The style of the label.
    pub style: LabelStyle,
    /// The range in bytes we are going to include in the final snippet.
    pub range: Span,
    /// An optional message to provide some additional information for the
    /// underlined code. These should not include line breaks.
    pub message: String,
}

impl Label {
    /// Create a new label with a style of [`LabelStyle::Primary`].
    ///
    /// [`LabelStyle::Primary`]: LabelStyle::Primary
    pub fn primary(file_id: &FileID, range: Span, message: impl Display) -> Self {
        Self { file_id: file_id.clone(), style: LabelStyle::Primary, range, message: message.to_string() }
    }
    /// Create a new label with a style of [`LabelStyle::Secondary`].
    ///
    /// [`LabelStyle::Secondary`]: LabelStyle::Secondary
    pub fn secondary(file_id: &FileID, range: Span, message: impl Display) -> Self {
        Self { file_id: file_id.clone(), style: LabelStyle::Secondary, range, message: message.to_string() }
    }
}