pub struct Verto { /* private fields */ }
Expand description
Entrypoint and configuration for verto.
This is a container that stores configuration options like dry_run
and a
list of plugins.
Implementations
sourceimpl Verto
impl Verto
pub fn new<T: AsRef<Path> + Debug>(
path: &T,
prefix: &str,
suffix: &str,
dry_run: bool
) -> Self
sourcepub fn plugin_names(&self) -> Vec<String>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A>where
A: Allocator,
pub fn plugin_names(&self) -> Vec<String>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A>where
A: Allocator,
A: Allocator,
Get a list of string names of plugins that are available.
sourcepub fn initialize(
&mut self,
branch: &Option<String>,
disabled_plugins: &[String]
) -> Result<()>
pub fn initialize(
&mut self,
branch: &Option<String>,
disabled_plugins: &[String]
) -> Result<()>
Errors
Will return an error if plugin initialization fails for a plugin.
sourcepub fn current_version(&self, plugin_name: &Option<String>) -> Result<Version>
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.
sourcepub fn next_version(
&self,
current_version: &Version,
plugin_name: &Option<String>
) -> Result<Version>
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.
sourcepub fn write(&mut self, next_version: &Version) -> Result<Vec<PathBuf>>
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.
Auto Trait Implementations
impl !RefUnwindSafe for Verto
impl !Send for Verto
impl !Sync for Verto
impl Unpin for Verto
impl !UnwindSafe for Verto
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more