pub struct SourceEngine { /* private fields */ }
Expand description

The Source Engine manages a relationship between file paths and their corresponding integer-based source IDs. Additionally, it maintains a reserve - a map that traces back from a source ID to its original file path. The primary objective of this system is to enable clients that need to reference a file path to do so using an integer-based ID. This numeric representation can be stored more efficiently as a key in a hashmap. The Source Engine is designed to be thread-safe. Its internal structures are secured by the RwLock mechanism. This allows its functions to be invoked using a straightforward non-mutable reference, ensuring safe concurrent access.

Implementations§

source§

impl SourceEngine

source

pub fn get_source_id(&self, path: &PathBuf) -> SourceId

This function retrieves an integer-based source ID for a provided path buffer. If an ID already exists for the given path, the function will return that existing ID. If not, a new ID will be created.

source

pub fn get_path(&self, source_id: &SourceId) -> PathBuf

This function provides the file path corresponding to a specified source ID.

Trait Implementations§

source§

impl Debug for SourceEngine

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for SourceEngine

source§

fn default() -> SourceEngine

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
§

impl<T> StorageAsMut for T

§

fn storage<Type>(&mut self) -> StorageMut<'_, Self, Type>where Type: Mappable,

§

fn storage_as_mut<Type>(&mut self) -> StorageMut<'_, Self, Type>where Type: Mappable,

§

impl<T> StorageAsRef for T

§

fn storage<Type>(&self) -> StorageRef<'_, Self, Type>where Type: Mappable,

§

fn storage_as_ref<Type>(&self) -> StorageRef<'_, Self, Type>where Type: Mappable,

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V