Struct aurum::Aurum

pub struct Aurum { /* fields omitted */ }

Aurum contains all of the configuration details for the crate, including configuration files, output callbacks, etc.

Methods

impl Aurum

TODO: Provide a way to pipe subprocess std streams

pub fn new(config_file: Option<impl AsRef<Path>>) -> Result<Aurum, Error>

Create a new instance of Aurum. This entails a number of things:

• Getting or creating a configuration
• Verifying that configuration
• Getting package info about packages already in the current configuration

pub fn action(&mut self, action: (ActionType, String))

The main way to interact with Aurum. Add a dependency to the top level of the dependency tree.

pub fn actions(&mut self, actions: Vec<(ActionType, String)>)

Helper function over self.action.

pub fn on_do_actions(
    &mut self,
    handler: fn(_: &Vec<(ActionType, &str)>) -> bool
)

handler is called by self.commit after dependency resolution occurs. The boolean returned by handler is used to determine whether or not the actions added to this instance of Aurum should be applied.

pub fn commit(self) -> Result<(), Error>

All the things happen here. It might take a little time.