Enum pdbtbx::Context

pub enum Context {
    None,
    Show {
        line: String,
    },
    FullLine {
        linenumber: usize,
        line: String,
    },
    Line {
        linenumber: usize,
        line: String,
        offset: usize,
        length: usize,
    },
    Range {
        start_linenumber: usize,
        lines: Vec<String>,
        offset: usize,
    },
    RangeHighlights {
        start_linenumber: usize,
        lines: Vec<String>,
        highlights: Vec<(usize, usize, usize)>,
    },
    Multiple {
        contexts: Vec<(Option<String>, Context)>,
    },
}

A struct to define the context of an error message

Variants

None

When no context can be given

Show

Fields

line: String

The line to be shown to the user (e.g. filename)

When only a line (e.g. in a file) can be shown

FullLine

Fields

linenumber: usize

The line number to recognise where the error is located

line: String

The line to show the issue itself

When a full line is faulty and no special position can be annotated

Line

Fields

linenumber: usize

The line number to recognise where the error is located.

line: String

The line to show the issue itself.

offset: usize

The offset of the special position to be annotated.

length: usize

The length of the special position to be annotated.

When a special position can be annotated on a line.

     |
104  | ATOM      O  N   MET A   1      27.251  24.447   2.594  1.00 11.79           N
     |        ^^^^
       <-   -><-->

The first space (annotated by <-, ->) is the offset, in this case 7. The second space is the length, in this case 4.

Range

Fields

start_linenumber: usize

The linenumber of the first line

lines: Vec<String>

The lines to show

offset: usize

The possible offset of the first line, will be padded with spaces

To show multiple lines where an error occurred.

RangeHighlights

Fields

start_linenumber: usize

The linenumber of the first line

lines: Vec<String>

The lines to show

highlights: Vec<(usize, usize, usize)>

Highlights defined by the line (relative to the set of lines given), start column in that line and length of highlight

To show multiple lines where an error occurred.

Multiple

Fields

contexts: Vec<(Option<String>, Context)>

The contexts to show

To show multiple contexts

Implementations

impl Context

pub const fn none() -> Context

Creates a new context when no context can be given

pub fn show(line: impl ToString) -> Context

Creates a new context when only a line (eg filename) can be shown

pub fn full_line(linenumber: usize, line: impl ToString) -> Context

Creates a new context when a full line is faulty and no special position can be annotated

pub fn line( linenumber: usize, line: impl ToString, offset: usize, length: usize ) -> Context

Creates a new context when a special position can be annotated on a line

pub fn position(pos: &Position<'_>) -> Context

Creates a new context to highlight a certain position

pub fn range(start: &Position<'_>, end: &Position<'_>) -> Context

Creates a new context from a start and end point within a single file

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Context

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

Formats the value using the given formatter.

impl Display for Context

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

Formats the value using the given formatter.

impl PartialEq<Context> for Context

fn eq(&self, other: &Context) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Context

impl StructuralEq for Context

impl StructuralPartialEq for Context