Skip to main content

VersionFile

Struct VersionFile 

Source
pub struct VersionFile<'context> { /* private fields */ }
Expand description

Reads and writes version files for a Git context.

Implementations§

Source§

impl<'context> VersionFile<'context>

Source

pub const fn new(context: &'context GitContext) -> Self

Creates a version-file accessor.

Source

pub fn is_version_defined(&self) -> Result<bool>

Returns whether a version file is defined at the context’s selected commit.

Source

pub fn get_version( &self, requirements: VersionFileRequirements, ) -> Result<(Option<VersionOptions>, VersionFileLocations)>

Reads from the selected Git commit, or from disk when no commit is selected.

Source

pub fn get_working_copy_version( &self, requirements: VersionFileRequirements, ) -> Result<(Option<VersionOptions>, VersionFileLocations)>

Reads version files from the working copy, including uncommitted changes.

Source

pub fn set_version( &self, project_directory: impl AsRef<Path>, version: &VersionOptions, include_schema_property: bool, ) -> Result<PathBuf>

Writes version.json, or preserves an existing version.txt when it can represent all the supplied options.

Auto Trait Implementations§

§

impl<'context> !Send for VersionFile<'context>

§

impl<'context> !Sync for VersionFile<'context>

§

impl<'context> Freeze for VersionFile<'context>

§

impl<'context> RefUnwindSafe for VersionFile<'context>

§

impl<'context> Unpin for VersionFile<'context>

§

impl<'context> UnsafeUnpin for VersionFile<'context>

§

impl<'context> UnwindSafe for VersionFile<'context>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.