Struct perseus::stores::immutable::ImmutableStore

pub struct ImmutableStore { /* private fields */ }

An immutable storage system used by Perseus’ engine to store build artifacts and the like, which will then be used by the server or the export process. By default, this is set to a path inside the dist/ folder at the root of your project, which you should only change if you have special requirements, as the CLI expects the default paths to be used, with no option for customization yet.

Note that this is only used for immutable data, which can be read-only in production, meaning there are no consequences of using this on a read-only production filesystem (e.g. in a serverless function). Data that do need to change use a MutableStore instead.

Implementations

impl ImmutableStore

pub fn new(root_path: String) -> Self

Creates a new immutable store. You should provide a path like dist here. Note that any trailing slashes will be automatically stripped.

pub fn get_path(&self) -> &str

Gets the filesystem path used for this immutable store.

This is designed to be used in particular by the engine to work out where to put static assets and the like when exporting.

pub async fn read(&self, name: &str) -> Result<String, StoreError>

Reads the given asset from the filesystem asynchronously.

pub async fn write(&self, name: &str, content: &str) -> Result<(), StoreError>

Writes the given asset to the filesystem asynchronously. This must only be used at build-time, and must not be changed afterward. Note that this will automatically create any missing parent directories.

Trait Implementations

impl Clone for ImmutableStore

fn clone(&self) -> ImmutableStore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImmutableStore

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

Formats the value using the given formatter.