Enum SourceMapError 

#[non_exhaustive]
pub enum SourceMapError {
    Oversize {
        name: Box<str>,
        len: u64,
    },
    SpaceExhausted {
        needed: u64,
        available: u64,
    },
    NotUtf8 {
        name: Box<str>,
    },
    Io {
        name: Box<str>,
        kind: ErrorKind,
    },
}

The reason a source could not be added to a SourceMap.

Adding a source can fail four ways, each a distinct, defined outcome rather than a panic or a silent corruption of the coordinate bookkeeping:

• the source is larger than the map’s per-source ceiling (Oversize),
• it does not fit in what remains of the shared 32-bit position space (SpaceExhausted),
• its bytes are not valid UTF-8 (NotUtf8), or
• the file behind a path could not be read (Io, std only).

Every variant names the source it concerns so the failure is actionable when it is logged far from the call that produced it.

The enum is #[non_exhaustive]: a downstream match must include a wildcard arm, so later additions never force a breaking change on callers.

Examples

use source_lang::{SourceMap, SourceMapError};

let mut map = SourceMap::new();
// Raw bytes that are not valid UTF-8 are rejected, naming the source.
let err = map.add_bytes("blob.bin", &[0xff, 0xfe]).unwrap_err();
assert!(matches!(err, SourceMapError::NotUtf8 { .. }));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Oversize

The source is larger than the map’s configured per-source ceiling.

The ceiling defaults to u32::MAX — the addressing limit of the global position space — and can be lowered with SourceMap::set_max_source_len to bound how much a single untrusted input may load. For a file, the size is checked against the path’s metadata before the bytes are read, so an oversize file is never pulled into memory.

Fields

name: Box<str>

Display name of the source that was rejected.

len: u64

Byte length of the source.

SpaceExhausted

The source did not fit in what remained of the map’s global space.

Returned when the source is no larger than the per-source ceiling but still exceeds the bytes left in the shared 32-bit position space — because earlier sources have consumed the remainder — or when the map already holds the maximum number of sources. The map is left unchanged, so the caller may start a fresh map or split the input.

Fields

needed: u64

Byte length of the source that was rejected.

available: u64

Bytes of global position space that remained available.

NotUtf8

The source’s bytes are not valid UTF-8.

A SourceMap stores text, so input from add_bytes or a file is validated before it is stored. A truncated multi-byte sequence or stray binary byte is reported here rather than stored as corrupt text.

Fields

name: Box<str>

Display name of the source whose bytes failed validation.

Io

Available on crate feature std only.

A file’s contents could not be read from disk.

Returned by add_file when opening or reading the path fails — a missing file, a directory, or a permission error. The std::io::ErrorKind distinguishes the cause without carrying a non-comparable std::io::Error, so this variant stays Clone and Eq like the rest.

Fields

name: Box<str>

Display name of the source (the path that was requested).

kind: ErrorKind

The category of I/O failure.

Trait Implementations

impl Clone for SourceMapError

fn clone(&self) -> SourceMapError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceMapError

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

Formats the value using the given formatter.

impl Display for SourceMapError

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

Formats the value using the given formatter.

impl Eq for SourceMapError

impl Error for SourceMapError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for SourceMapError

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