Struct sbvc_lib::Version

pub struct Version(_);

A struct that represents a single commit in the version tree. It uses Arc under the hood, so it is okay to clone it, as it has very little cost.

Implementations

impl Version

pub fn data(&self) -> Pin<Box<dyn Send + Sync + Future<Output = Vec<u8>>>>

Returns contents of the controlled file in given version.

This method does not cache anything or use any cached values. Instead, it calculates contents of the file every time this method is called using differences contained in the database, so you should either cache contents yourself, or do not call this method very often.

pub async fn delete(&self) -> Result<()>

Deletes given version and all its children from the version tree.

Errors

This method returns an error if error happens while deleting records from the database.

pub async fn rollback(&self) -> Result<()>

Rolls the controlled file back to its state at given version.

Errors

This method returns an error if an IO error occurs while trying to write into the file.

pub async fn rename(&self, name: String) -> Result<()>

Renames the version to given name.

Errors

This method returns an error if an error occurs while trying to update values in the database.

pub async fn commit(&self) -> Result<()>

Commits file’s new state into the version tree.

The new version will be child of self.

Errors

This method returns an error if an error occurs while trying to insert values into the database.

pub async fn id(&self) -> u32

Returns ID of the version.

pub async fn base(&self) -> Option<Version>

Returns parent version of self. Returns None if there is none.

pub async fn name(&self) -> String

Returns name of the version.

pub async fn date(&self) -> String

Returns date when the version was commited.

This method returns String representation of the date in the same format it was stores in the database.

pub async fn deletions(&self) -> usize

Returns number of deletions from the file in this version.

pub async fn insertions(&self) -> usize

Returns number of insertions into the file in this version.

pub async fn children(&self) -> Vec<Version>

Returns all the children of the version.

Trait Implementations

impl Clone for Version

fn clone(&self) -> Version

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.