Struct daab::ArtifactCache

pub struct ArtifactCache<T: ?Sized = dyn Doctor> { /* fields omitted */ }

Central structure to prevent dependency duplication on building.

Notice the debugging version (activating the diagnostics feature) of this struct contains a debugging Doctor, which allows run-time inspection of various events. Therefore, ArtifactCache is generic to some Doctor. Thus, the new() function returns actually a ArtifactCache<NoopDoctor> and new_with_doctor() returns some ArtifactCache<T> those can be store in variables.

However, since most of the code does not care about the concrete Doctor the default generic is dyn Doctor. To ease conversion between them, all creatable ArtifactCaches (i.e. not ArtifactCache<dyn Doctor>) implement DerefMut to ArtifactCache<dyn Doctor> which has all the methods implemented.

Methods

impl ArtifactCache<DefDoctor>

pub fn new() -> Self

Creates a new empty cache with a dummy doctor.

impl<T: Doctor + 'static> ArtifactCache<T>

pub fn new_with_doctor(doctor: T) -> Self

Creates new empty cache with given doctor for drop-in inspection.

Notice: This function is only available if the diagnostics feature has been activated.

pub fn get_doctor(&mut self) -> &mut T

Returns a reference of the inner doctor.

Notice: This function is only available if the diagnostics feature has been activated.

pub fn into_doctor(self) -> T

Consumes the ArtifactCache and returns the inner doctor.

Notice: This function is only available if the diagnostics feature has been activated.

impl ArtifactCache

pub fn get<B: Builder + 'static>(
    &mut self,
    promise: &ArtifactPromise<B>
) -> Rc<B::Artifact> where
    <B as Builder>::Artifact: 'static, 

Gets the artifact of the given builder.

This method looks up whether the artifact for the given builder is still present in the cache, or it will use the builder to build and store the artifact.

Notice the given promise will be stored kept to prevent it from deallocating. clear() or invalidate() must be called in order to free those Rcs if required.

pub fn clear(&mut self)

Clears the entire cache including all kept builder and artifact Rcs.

pub fn invalidate<B: Builder + 'static>(&mut self, promise: &ArtifactPromise<B>)

Clears cached artifact of the given builder and all depending artifacts.

Depending artifacts are all artifacts which used the former during its building. The dependencies are automatically tracked using the ArtifactResolver struct.

Methods from Deref<Target = ArtifactCache>

pub fn get_doctor(&mut self) -> &mut T

Returns a reference of the inner doctor.

Notice: This function is only available if the diagnostics feature has been activated.

pub fn get<B: Builder + 'static>(
    &mut self,
    promise: &ArtifactPromise<B>
) -> Rc<B::Artifact> where
    <B as Builder>::Artifact: 'static, 

Gets the artifact of the given builder.

This method looks up whether the artifact for the given builder is still present in the cache, or it will use the builder to build and store the artifact.

Notice the given promise will be stored kept to prevent it from deallocating. clear() or invalidate() must be called in order to free those Rcs if required.

pub fn clear(&mut self)

Clears the entire cache including all kept builder and artifact Rcs.

pub fn invalidate<B: Builder + 'static>(&mut self, promise: &ArtifactPromise<B>)

Clears cached artifact of the given builder and all depending artifacts.

Depending artifacts are all artifacts which used the former during its building. The dependencies are automatically tracked using the ArtifactResolver struct.

Trait Implementations

impl Default for ArtifactCache<DefDoctor>

fn default() -> Self

Returns the "default value" for a type.

impl<T: Doctor + 'static> Deref for ArtifactCache<T>

type Target = ArtifactCache

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Doctor + 'static> DerefMut for ArtifactCache<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.