rspack_core 0.100.5

rspack core
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

pub mod make;
pub mod meta;
pub mod minimize;

use std::future::Future;

pub use make::MakeOccasion;
pub use meta::MetaOccasion;
pub use minimize::{
  CachedExtractedComments, CachedMinimizeEntry, MinimizeOccasion, MinimizePersistentCacheArtifact,
};
use rspack_error::Result;

use super::storage::Storage;

/// An `Occasion` represents a distinct phase of the persistent cache lifecycle.
///
/// Each occasion owns one storage scope and is responsible for:
/// - serialising its artifact into storage (`save`)
/// - deserialising its artifact from storage (`recovery`)
/// - clearing its scope when the cached data is stale (`reset`)
///
/// `BuildDeps` and `Snapshot` are not occasions: they operate across multiple
/// scopes and have more complex lifecycle semantics.
pub trait Occasion {
  /// The data produced/consumed by this occasion.
  type Artifact: Send;

  /// Human-readable occasion name used in persistent cache logging.
  fn name(&self) -> &'static str;

  /// Clear this occasion's scope in storage.
  fn reset(&self, storage: &mut dyn Storage);

  /// Persist `artifact` into storage.  Only called when not in readonly mode.
  fn save(&self, storage: &mut dyn Storage, artifact: &Self::Artifact);

  /// Load and reconstruct the artifact from storage.
  fn recovery<'a>(
    &'a self,
    storage: &'a dyn Storage,
  ) -> impl Future<Output = Result<Self::Artifact>> + Send + 'a;
}