Struct devlog::repository::LogRepository

pub struct LogRepository { /* fields omitted */ }

Represents a devlog repository

Methods

impl LogRepository

pub fn new(p: &Path) -> LogRepository

Creates a handle to the devlog repository at the specified path. The directory may or may not exist.

pub fn initialized(&self) -> Result<bool, Error>

Checks if the repository has been initialized.

pub fn init(&self) -> Result<LogPath, Error>

Initializes the repository. This creates the directory if it does not exist, as well as the first devlog entry file with sequence number one. Fails with an IOError if the first devlog entry already exists.

pub fn path(&self) -> &Path

Returns the path to the repository directory, which may or may not exist.

pub fn list(&self) -> Result<Vec<LogPath>, Error>

Returns all paths to devlog entry files in the repository. The paths are not necessarily ordered.

pub fn tail(&self, limit: usize) -> Result<Vec<LogPath>, Error>

Returns the most recent devlog entry file paths. limit is the maximum number of paths that may be returned.

pub fn latest(&self) -> Result<Option<LogPath>, Error>

Returns the most recent devlog entry file path, or None if the repository has not yet been initialized.

pub fn nth_from_latest(&self, n: usize) -> Result<Option<LogPath>, Error>

Returns the "nth" most recent devlog entry file path. For example, n=0 is the most recent entry, n=1 is the second most recent entry, and so on. Returns None if the repository has not yet been initialized.