Struct CodexRepoConfig

pub struct CodexRepoConfig { /* private fields */ }

A CodexRepoConfig is the parameters for making a CodexRepository.

Implementations

impl CodexRepoConfig

pub fn set_user(&mut self, val: User) -> &mut Self

user name and email for Git commits

pub fn set_remote_url(&mut self, val: String) -> &mut Self

URL for the remote repository

pub fn set_path(&mut self, val: PathBuf) -> &mut Self

where to put the files on disk (excluding the repo name)

pub fn set_auto_add(&mut self, val: Vec<String>) -> &mut Self

paths to add automatically

pub fn set_ssh_keys(&mut self, val: SshKeys) -> &mut Self

SSH keys for the remote

impl CodexRepoConfig

pub fn repo_name(&self) -> Result<String>

repo_name is the name of the repository

pub fn full_path(&self) -> Result<PathBuf>

full_path is the full path of the head of the repository on disk including the Self::repo_name()

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

has_repository detects whether a CodexRepository exists for this CodexRepoConfig.

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

delete_repo deletes the repository.

pub fn clone_repo(&mut self) -> Result<CodexRepository>

clone_repo creates a CodexRepository and clones the repository from the remote (a Git clone, not a Rust clone).

pub fn open(&self) -> Result<CodexRepository>

open opens an existing CodexRepository.

Trait Implementations

impl Clone for CodexRepoConfig

fn clone(&self) -> CodexRepoConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodexRepoConfig

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

Formats the value using the given formatter.

impl Default for CodexRepoConfig

fn default() -> CodexRepoConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CodexRepoConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.