Enum SourceMapError 

#[non_exhaustive]
pub enum SourceMapError {
    SpaceExhausted {
        needed: u64,
        available: u64,
    },
}

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

Every source in a map shares one 32-bit global position space, so the combined byte length of all sources cannot exceed u32::MAX, and the map can hold at most u32::MAX distinct sources. Adding a source that would cross either limit fails with this error rather than wrapping a base offset into a neighbour’s range — the one way the coordinate bookkeeping could otherwise corrupt silently.

The enum is #[non_exhaustive]: later phases add file-loading failures (missing path, oversize file) alongside this variant, and a match on it must already account for that.

Examples

use source_lang::{SourceMap, SourceMapError};

// A map whose global space is almost full rejects a source that overruns it.
let mut map = SourceMap::new();
let id = map.add("ok.txt", "fits fine").expect("plenty of room");
assert_eq!(map.source(id).map(|f| f.name()), Some("ok.txt"));

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.

SpaceExhausted

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

Returned when the new source is larger than the bytes left in the global position space — either because the single source exceeds u32::MAX bytes, or because earlier sources have consumed the remainder — or when the map already holds the maximum number of sources. The caller cannot retry the same source against the same map; it must split the input or start a fresh map.

Fields

needed: u64

Byte length of the source that was rejected.

available: u64

Bytes of global position space that remained available.

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 Copy for SourceMapError

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