Struct brevdash_data::Repository

pub struct Repository {
    pub description: RootDescription,
    // some fields omitted
}

Definition of a brevdash data repository.

Fields

description: RootDescription

The root description string.

Implementations

impl Repository

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open a repository from a directory path.

pub fn create<P: AsRef<Path>>(
    path: P,
    description: RootDescription
) -> Result<Self>

Create a repository at a directory path.

The directory must already exist and be writable.

pub fn store_description(&self) -> Result<()>

Store the description file inside the repository.

pub fn project_datapoint_characteristic_artifacts_directory_path(
    &self,
    project_id: &str,
    date: NaiveDate,
    characteristic_id: &str
) -> PathBuf

Get the path for the artifacts of a characteristic at a specific date.

pub fn project_datapoint_characteristic_artifact_path(
    &self,
    project_id: &str,
    date: NaiveDate,
    characteristic_id: &str,
    artifact_relative_path: &Path
) -> PathBuf

Get the path for an artifact.

pub fn load_project_ids(&self) -> Result<Vec<String>>

Load the list of project ids inside the repository.

pub fn has_project(&self, project_id: &str) -> bool

Query whether the repository contains a project with a specific id.

pub fn store_project_description(
    &self,
    project_id: &str,
    description: &ProjectDescription
) -> Result<()>

Store the description of a project.

pub fn load_project_description(
    &self,
    project_id: &str
) -> Result<ProjectDescription>

Load the description of a project by id.

pub fn load_project_descriptions(
    &self
) -> Result<BTreeMap<String, ProjectDescription>>

Load the descriptions for all projects.

pub fn project_has_datapoint_date(
    &self,
    project_id: &str,
    date: NaiveDate
) -> bool

Query whether the repository contains a datapoint at a specific date.

pub fn load_project_datapoint_dates(
    &self,
    project_id: &str
) -> Result<Vec<NaiveDate>>

Load a list of all datapoint dates for a specific project id.

pub fn store_project_datapoint(
    &self,
    project_id: &str,
    date: NaiveDate,
    datapoint: &DataPoint
) -> Result<()>

Store a datapoint at a specific date.

pub fn load_project_datapoint(
    &self,
    project_id: &str,
    date: NaiveDate
) -> Result<DataPoint>

Load a datapoint at a specific date.

pub fn load_project_datapoints(
    &self,
    project_id: &str
) -> Result<BTreeMap<NaiveDate, DataPoint>>

Load all datapoints for a project id.

Trait Implementations

impl Debug for Repository

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.