Struct SourceEngine

pub struct SourceEngine { /* private fields */ }

The Source Engine manages a relationship between file paths and their corresponding integer-based source IDs. Additionally, it maintains the reverse - 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

impl SourceEngine

pub fn is_span_in_autogenerated(&self, span: &Span) -> Option<bool>

pub fn is_source_id_autogenerated(&self, source_id: &SourceId) -> bool

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.

pub fn get_source_id_with_program_id( &self, path: &PathBuf, program_id: ProgramId, ) -> SourceId

pub fn get_autogenerated_source_id(&self, program_id: ProgramId) -> SourceId

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

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

pub fn get_program_id(&self, path: &PathBuf) -> Option<ProgramId>

This function provides the ProgramId corresponding to a specified manifest file path.

pub fn get_manifest_path_from_program_id( &self, program_id: &ProgramId, ) -> Option<PathBuf>

Returns the PathBuf associated with the provided ProgramId, if it exists in the manifest_path_to_program_map.

pub fn get_file_name(&self, source_id: &SourceId) -> Option<String>

This function provides the file name (with extension) corresponding to a specified source ID.

pub fn all_files(&self) -> Vec<PathBuf>

pub fn get_source_ids_from_program_id( &self, program_id: ProgramId, ) -> Option<BTreeSet<SourceId>>

Trait Implementations

impl Clone for SourceEngine

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceEngine

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

Formats the value using the given formatter.

impl Default for SourceEngine

fn default() -> SourceEngine

Returns the “default value” for a type.