Struct verto::Verto

pub struct Verto { /* private fields */ }

Entrypoint and configuration for verto.

This is a container that stores configuration options like dry_run and a list of plugins.

Implementations

impl Verto

pub fn new<T: AsRef<Path> + Debug>(
    path: &T,
    prefix: &str,
    suffix: &str,
    dry_run: bool
) -> Self

pub fn plugin_names(&self) -> Vec<String>

Get a list of string names of plugins that are available.

pub fn initialize(
    &mut self,
    branch: &Option<String>,
    disabled_plugins: &[String]
) -> Result<()>

Errors

Will return an error if plugin initialization fails for a plugin.

pub fn current_version(&self, plugin_name: &Option<String>) -> Result<Version>

Errors

Will return an error if enabled plugins detect different current versions. This probably means that various files on disk and git history have gotten out of sync.

pub fn next_version(
    &self,
    current_version: &Version,
    plugin_name: &Option<String>
) -> Result<Version>

Errors

Will return an error if no enabled plugin returned a next version or different next versions were returned by different plugins.

pub fn write(&mut self, next_version: &Version) -> Result<Vec<PathBuf>>

Go through each plugin and have it write the version. What this means will vary depending on which plugins are enabled, and how they work internally.

Errors

Will return an error if any of the plugins returns an error. See documentation for each plugin for details.

pub fn commit<T: AsRef<Path>>(
    &mut self,
    next_version: &Version,
    files: &[T]
) -> Result<()>

Commit any versioning changes.

Errors

Returns an error if any of the plugins return an error when their commit method is called.