Struct paralegal_policy::SPDGGenCommand

pub struct SPDGGenCommand(pub(crate) Command);

Configuration of the cargo paralegal-flow command.

Takes care of passing the right kinds of arguments to produce the ProgramDescription graph that the properties consume.

Construct the command with Self::global or Self::custom, customize it further with Self::get_command and once you are ready, execute it with Self::run.

Tuple Fields

0: Command

Implementations

impl SPDGGenCommand

pub fn global() -> Self

Use a global installation of paralegal-flow via cargo paralegal-flow.

pub fn custom(cmd: Command) -> Self

Use a custom binary or base invocation as command.

pub fn get_command(&mut self) -> &mut Command

Mutably borrow the command to perform further customization.

This gives you raw access to the underlying command. Be aware that if you pass -- with Command::arg or Command::args then methods such as Self::external_annotations and Self::abort_after_analysis not longer work properly after this call.

pub fn external_annotations(&mut self, file: impl AsRef<Path>) -> &mut Self

Pass the provided file as --external-annotations to the command.

pub fn abort_after_analysis(&mut self) -> &mut Self

Abort compilation once the analysis artifacts have been created. Also sets the expectation for the compilation to succeed to false.

pub fn run(&mut self, dir: impl AsRef<Path>) -> Result<GraphLocation>

Consume the created command and execute it in the specified directory.

Errors if executing the underlying Command fails or if it does not terminate successfully.

To run yor properties on the results see GraphLocation.

Trait Implementations

impl Debug for SPDGGenCommand

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

Formats the value using the given formatter.