Struct RepositoryOptions 

#[non_exhaustive]
pub struct RepositoryOptions {

    pub environment: Environment,
    pub command_runner: Arc<dyn CommandRunner>,
    pub change_id_generator: Arc<dyn ChangeIdGenerator>,
    pub diagnostics: DiagnosticsHandle,
    pub network_trace: bool,
    pub test_assume_different_owner: bool,
    pub reference_unix_time: Option<i64>,
    pub thread_policy: ThreadPolicy,
    pub work_tree: Option<PathBuf>,
    pub validate_repository_format: bool,
    pub open_for_serving: bool,
    pub promisor_fetcher: Option<Arc<dyn PromisorFetcher>>,
    pub hook_stdio: HookStdio,
}

Options passed to repository open/discover with an explicit Environment.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

environment: Environment

Discovery and configuration environment.

command_runner: Arc<dyn CommandRunner>

Subprocess runner for hooks, filters, and helpers.

change_id_generator: Arc<dyn ChangeIdGenerator>

Random bytes for new change ids (grit.changeIds).

diagnostics: DiagnosticsHandle

Where non-fatal warnings and trace events are delivered.

network_trace: bool

When true, network operations may emit crate::diagnostics::Trace::Network events.

test_assume_different_owner: bool

When true, treat repository ownership as a different user (safe.directory tests).

reference_unix_time: Option<i64>

Wall-clock reference for rev-parse date selectors; embedders set explicitly.

thread_policy: ThreadPolicy

Parallel worker overrides (--threads in the CLI).

work_tree: Option<PathBuf>

Work tree path for crate::repo::Repository::open (non-bare repos).

validate_repository_format: bool

When false, skip crate::repo::validate_repo_format during open.

open_for_serving: bool

When true, crate::repo::Repository::open resolves path like wire-protocol serving.

promisor_fetcher: Option<Arc<dyn PromisorFetcher>>

Optional on-demand fetcher for partial-clone promisor objects.

hook_stdio: HookStdio

Where hook subprocesses write their output (captured by default).

Implementations

impl RepositoryOptions

pub fn empty() -> Self

Shorthand for Environment::empty.

pub fn with_environment(environment: Environment) -> Self

Build options around an explicit Environment snapshot.

pub fn with_command_runner(self, runner: Arc<dyn CommandRunner>) -> Self

Override the injectable subprocess runner used for hooks and filters.

pub fn with_change_id_generator( self, generator: Arc<dyn ChangeIdGenerator>, ) -> Self

Override the generator used for random change ids on new commits.

pub fn with_work_tree(self, work_tree: impl Into<PathBuf>) -> Self

Attach an explicit work tree for crate::repo::Repository::open.

pub fn without_format_validation(self) -> Self

Skip repository format validation when opening (discovery follow-up paths).

pub fn for_serving(self) -> Self

Resolve path for smart-HTTP / upload-pack serving instead of a bare git directory.

pub fn with_diagnostics(self, diagnostics: DiagnosticsHandle) -> Self

Override the diagnostic sink for warnings and trace events.

pub fn with_hook_stdio(self, hook_stdio: HookStdio) -> Self

Choose whether hooks run by repositories opened with these options have their output captured (HookStdio::Capture, the default) or write straight to this process’s stderr.

pub fn with_network_trace(self, network_trace: bool) -> Self

Enable or disable network trace events.

pub fn with_promisor_fetcher( self, fetcher: Option<Arc<dyn PromisorFetcher>>, ) -> Self

Install a promisor on-demand object fetcher for repositories opened with these options.

Trait Implementations

impl Clone for RepositoryOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RepositoryOptions

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

Formats the value using the given formatter.

impl Default for RepositoryOptions

fn default() -> Self

Returns the “default value” for a type.