Struct SourceId 

pub struct SourceId(/* private fields */);

A small, copyable handle to one source in a SourceMap.

A SourceId is a 32-bit index minted by the map when a source is added. It is stable for the life of the map: the id returned by SourceMap::add keeps pointing at the same source no matter how many more are added afterwards, because sources are only ever appended. That stability is what lets a token, an AST node, or a cached diagnostic store a SourceId and resolve it later.

The id is deliberately opaque — there is no public constructor — so an id can only come from a map that actually holds the source it names. Pass it back to SourceMap::source to borrow the source, or to the result of SourceMap::locate to identify where a global position resolved.

Examples

use source_lang::SourceMap;

let mut map = SourceMap::new();
let first = map.add("a.txt", "alpha").expect("fits");
let second = map.add("b.txt", "beta").expect("fits");

// Ids are assigned in order and stay distinct.
assert_eq!(first.to_u32(), 0);
assert_eq!(second.to_u32(), 1);
assert_ne!(first, second);

With the serde feature it serialises transparently as its u32 index, so a handle stored in an AST node or a cached diagnostic round-trips on its own.

Implementations

impl SourceId

pub const fn to_u32(self) -> u32

Returns the raw index this id wraps.

The value is the source’s insertion order, starting at 0. It is useful as a dense array key — for a side table of per-source data — but the id itself should be preferred wherever an opaque handle will do.

Examples

use source_lang::SourceMap;

let mut map = SourceMap::new();
let id = map.add("only.txt", "x").expect("fits");
assert_eq!(id.to_u32(), 0);

Trait Implementations

impl Clone for SourceId

fn clone(&self) -> SourceId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SourceId

impl Debug for SourceId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SourceId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SourceId

impl Hash for SourceId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SourceId

fn cmp(&self, other: &SourceId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SourceId

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

fn partial_cmp(&self, other: &SourceId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SourceId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SourceId