Struct rif::Rif

pub struct Rif { /* fields omitted */ }

Rif struct stores all iformation necessary for rif operations

Implementations

impl Rif

pub fn new(path: Option<impl AsRef<Path>>) -> Result<Self, RifError>

Create new rif struct

pub fn init(
    path: Option<impl AsRef<Path>>,
    create_rif_ignore: bool
) -> Result<(), RifError>

Initiate given directory

If directory is not supplied, initiates current working directory

pub fn add(
    &mut self,
    files: &Vec<impl AsRef<Path>>,
    force: bool
) -> Result<(), RifError>

Add new file

Files that modified, newly created, deleted files can be added but non modiifed files can alos be added with force option

pub fn revert(
    &mut self,
    files: Option<&Vec<impl AsRef<Path>>>
) -> Result<(), RifError>

Revert added files

No files arugment revert all added files

pub fn commit(&mut self, message: Option<&str>) -> Result<(), RifError>

Commit addition to rif struct and check impact

Message is saved inside history file

pub fn discard(&mut self, file: impl AsRef<Path>) -> Result<(), RifError>

Discard file change and updated filestamp

This cannot be reverted so multiple files are not supported

pub fn rename(
    &mut self,
    source_name: &str,
    new_name: &str
) -> Result<(), RifError>

Rename rif file

If file exist, change the file name in filesystem

pub fn remove(&mut self, files: &Vec<impl AsRef<Path>>) -> Result<(), RifError>

Remove file from rif

pub fn set(
    &mut self,
    file: &Path,
    refs: &Vec<impl AsRef<Path>>
) -> Result<(), RifError>

Set reference of file

pub fn unset(
    &mut self,
    file: &Path,
    refs: &Vec<impl AsRef<Path>>
) -> Result<(), RifError>

Unset reference of file

pub fn status(&mut self, ignore: bool, verbose: bool) -> Result<(), RifError>

Show current status of rif project

pub fn list(
    &self,
    file: Option<impl AsRef<Path>>,
    list_type: ListType,
    depth: Option<usize>
) -> Result<(), RifError>

Show file informations of rif project

pub fn data(
    &self,
    data_type: Option<&str>,
    compact: bool
) -> Result<(), RifError>

Show data of rif project

pub fn depend(&self, file: &Path) -> Result<(), RifError>

Show files that depend on given file

pub fn check(&mut self) -> Result<(), RifError>

Check file references

pub fn sanity(&mut self, fix: bool) -> Result<(), RifError>

Check sanity of rif proeject