Struct git2::RepositoryInitOptions

pub struct RepositoryInitOptions { /* private fields */ }

Options which can be used to configure how a repository is initialized

Implementations

impl RepositoryInitOptions

pub fn new() -> RepositoryInitOptions

Creates a default set of initialization options.

By default this will set flags for creating all necessary directories and initializing a directory from the user-configured templates path.

pub fn bare(&mut self, bare: bool) -> &mut RepositoryInitOptions

Create a bare repository with no working directory.

Defaults to false.

pub fn no_reinit(&mut self, enabled: bool) -> &mut RepositoryInitOptions

Return an error if the repository path appears to already be a git repository.

Defaults to false.

pub fn no_dotgit_dir(&mut self, enabled: bool) -> &mut RepositoryInitOptions

Normally a ‘/.git/’ will be appended to the repo path for non-bare repos (if it is not already there), but passing this flag prevents that behavior.

Defaults to false.

pub fn mkdir(&mut self, enabled: bool) -> &mut RepositoryInitOptions

Make the repo path (and workdir path) as needed. The “.git” directory will always be created regardless of this flag.

Defaults to true.

pub fn mkpath(&mut self, enabled: bool) -> &mut RepositoryInitOptions

Recursively make all components of the repo and workdir path as necessary.

Defaults to true.

pub fn mode(&mut self, mode: RepositoryInitMode) -> &mut RepositoryInitOptions

Set to one of the RepositoryInit constants, or a custom value.

pub fn external_template(&mut self, enabled: bool) -> &mut RepositoryInitOptions

Enable or disable using external templates.

If enabled, then the template_path option will be queried first, then init.templatedir from the global config, and finally /usr/share/git-core-templates will be used (if it exists).

Defaults to true.

pub fn workdir_path(&mut self, path: &Path) -> &mut RepositoryInitOptions

The path to the working directory.

If this is a relative path it will be evaluated relative to the repo path. If this is not the “natural” working directory, a .git gitlink file will be created here linking to the repo path.

pub fn description(&mut self, desc: &str) -> &mut RepositoryInitOptions

If set, this will be used to initialize the “description” file in the repository instead of using the template content.

pub fn template_path(&mut self, path: &Path) -> &mut RepositoryInitOptions

When the external_template option is set, this is the first location to check for the template directory.

If this is not configured, then the default locations will be searched instead.

pub fn initial_head(&mut self, head: &str) -> &mut RepositoryInitOptions

The name of the head to point HEAD at.

If not configured, this will be taken from your git configuration. If this begins with refs/ it will be used verbatim; otherwise refs/heads/ will be prefixed

pub fn origin_url(&mut self, url: &str) -> &mut RepositoryInitOptions

If set, then after the rest of the repository initialization is completed an origin remote will be added pointing to this URL.

pub unsafe fn raw(&self) -> git_repository_init_options

Creates a set of raw init options to be used with git_repository_init_ext.

This method is unsafe as the returned value may have pointers to the interior of this structure.