Struct GraphLocation

pub struct GraphLocation {
    pub(crate) path: PathBuf,
    pub(crate) construction_time: Option<Duration>,
}

A path to a ProgramDescription file from which a Context can be created.

Can be created programmatically and automatically by running SPDGGenCommand::run or you can create one manually if you can cargo paralegal-flow by hand with Self::custom.

Fields

path: PathBuf

construction_time: Option<Duration>

Implementations

impl GraphLocation

pub fn std(dir: impl AsRef<Path>) -> Self

Use the default graph file name in the specified directory.

pub fn stats_path(&self) -> PathBuf

Get the path where the analyzzer wrote statistics to. Use this path to read a paralegal_spdg::AnalyzerStats::canonical_read.

pub fn custom(path: PathBuf) -> Self

Use a completely custom path (directory and file name).

pub fn path(&self) -> &Path

Inspect the path that will be loaded

pub fn with_context<A>( &self, prop: impl FnOnce(Arc<RootContext>) -> Result<A>, ) -> Result<PolicyReturn<A>>

Builds a context, then runs the property.

Emits any recorded diagnostic messages to stdout and aborts the program if they were severe enough.

pub fn with_context_configured<A>( &self, config: Config, prop: impl FnOnce(Arc<RootContext>) -> Result<A>, ) -> Result<PolicyReturn<A>>

Builds a context, then runs the property.

Emits any recorded diagnostic messages to stdout and aborts the program if they were severe enough.

pub fn build_context(&self, config: Config) -> Result<RootContext>

Read and parse this graph file, returning a Context suitable for property enforcement.

Prefer using Self::with_context which takes care of emitting any diagnostic messages after the property is done.