mago_source

Struct SourceManager

Source
pub struct SourceManager { /* private fields */ }
Expand description

A manager for sources, which stores sources and provides methods to insert and retrieve them.

Implementations§

Source§

impl SourceManager

Source

pub fn new(interner: ThreadedInterner) -> Self

Creates a new source manager with the given interner.

§Parameters
  • interner: The interner to use for source names.
§Returns

The new source manager.

Source

pub fn insert_path( &self, name: String, path: PathBuf, category: SourceCategory, ) -> SourceIdentifier

Inserts a source with the given name and path into the manager.

§Parameters
  • name: The name of the source.
  • path: The path to the source.
  • category: The category of the source.
§Returns

The identifier of the inserted source.

Source

pub fn insert_content( &self, name: String, content: String, category: SourceCategory, ) -> SourceIdentifier

Inserts a source with the given name and content into the manager.

§Parameters
  • name: The name of the source.
  • content: The content of the source.
  • category: The category of the source.
§Returns

The identifier of the inserted source.

Source

pub fn contains(&self, source_id: &SourceIdentifier) -> bool

Checks whether the manager contains a source with the given identifier.

§Parameters
  • source_id: The identifier of the source to check for.
§Returns

Whether the manager contains a source with the given identifier.

Source

pub fn source_ids(&self) -> impl Iterator<Item = SourceIdentifier> + '_

Retrieve an iterator over all source identifiers in the manager.

Source

pub fn source_ids_for_category( &self, category: SourceCategory, ) -> impl Iterator<Item = SourceIdentifier> + '_

Retrieve an iterator over all source identifiers in the manager for the given category.

Source

pub fn source_ids_except_category( &self, category: SourceCategory, ) -> impl Iterator<Item = SourceIdentifier> + '_

Retrieve an iterator over all source identifiers in the manager for categories other than the given category.

Source

pub fn load(&self, source_id: &SourceIdentifier) -> Result<Source, SourceError>

Retrieve the source with the given identifier from the manager.

§Parameters
  • source_id: The identifier of the source to retrieve.
§Returns

The source with the given identifier, or an error if the source does not exist, or could not be loaded.

Source

pub fn write( &self, source_id: SourceIdentifier, content: String, ) -> Result<(), SourceError>

Source

pub fn len(&self) -> usize

Retrieve the number of sources in the manager.

Source

pub fn is_empty(&self) -> bool

Check whether the manager is empty.

Trait Implementations§

Source§

impl Clone for SourceManager

Source§

fn clone(&self) -> SourceManager

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SourceManager

Source§

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

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

impl Send for SourceManager

Source§

impl Sync for SourceManager

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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 T
where U: TryFrom<T>,

Source§

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more