Struct polysite::builder::context::Context

pub struct Context { /* private fields */ }

Compiling context

This holds global, compiling (local) and versions’ Metadata, snapshot manager. This also provides some helper methods.

Implementations

impl Context

pub fn new(config: Config) -> Self

pub async fn metadata(&self) -> Metadata

Get Metadata that merges global and compiling metadata

pub fn compiling_metadata(&self) -> Result<&Metadata>

Get compiling Metadata

pub async fn insert_global_metadata( &self, name: impl ToString, value: impl Serialize ) -> Result<()>

Insert global Metadata

You can pass anything which can be serialized and deserialized to serde_json::Value.

pub fn insert_compiling_metadata( &mut self, name: impl ToString, value: impl Serialize ) -> Result<()>

Insert compiling Metadata

You can pass anything which can be serialized and deserialized to serde_json::Value.

pub async fn insert_global_raw_metadata( &self, name: impl ToString, metadata: Metadata )

Insert raw Metadata value to global metadata

pub fn insert_compiling_raw_metadata( &mut self, name: impl ToString, metadata: Metadata ) -> Result<()>

Insert raw Metadata value to compiling metadata

pub fn version(&self) -> Result<Version>

Get currently compiling Version

pub async fn get_version_metadata( &self, version: impl Into<Version>, path: &PathBuf ) -> Option<Metadata>

Get specified Version and source’s metadata’

pub async fn insert_version( &self, version: impl Into<Version>, path: PathBuf, metadata: Metadata ) -> Result<()>

Insert specified Version and source’s metadata

pub async fn wait_snapshot_until( &self, name: impl ToString, stage: usize ) -> Result<()>

Wait snapshot until specified stage. In most cases, you would like to wait until stage 1, that means “first snapshot was taken”.

pub async fn save_snapshot(&self) -> Result<()>

Save currently compiling Metadata as snapshot

pub fn rule(&self) -> Result<String>

Get currently compiling rule name

pub fn source(&self) -> Result<PathBuf>

Get currently compiling source file path

pub fn target(&self) -> Result<PathBuf>

Get currently compiling target file path

pub fn path(&self) -> Result<PathBuf>

Get currently compiling URL path

pub fn body(&self) -> Result<Metadata>

Get currently compiling body Metadata, which can be Vec<u8> or String.

pub fn config(&self) -> Config

Get Config

pub fn get_source_body(&self) -> Result<Vec<u8>>

Get source file body as bytes

pub fn get_source_string(&self) -> Result<String>

Get source file string

pub fn get_source_data(&self) -> Result<Metadata>

Get source file data as Metadata

pub fn create_target_parent_dir(&self) -> Result<()>

Create target file’s parent directory

pub fn open_target(&self) -> Result<File>

Open target file to write

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

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

Performs copy-assignment from source.