Struct gix_filter::Driver

pub struct Driver {
    pub name: BString,
    pub clean: Option<BString>,
    pub smudge: Option<BString>,
    pub process: Option<BString>,
    pub required: bool,
}

A declaration of a driver program.

It consists of up to three program declarations.

Fields

name: BString

The name of the driver as stored in the configuration.

clean: Option<BString>

The program invocation that cleans a worktree file for storage in git.

Note that the command invocation may need its %f argument substituted with the name of the file to process. It will be quoted.

smudge: Option<BString>

The program invocation that readies a file stored in git for the worktree.

Note that the command invocation may need its %f argument substituted with the name of the file to process. It will be quoted.

process: Option<BString>

the long-running program that can typically handle both smudge and clean, and possibly delay processing as well.

required: bool

If true, the clean or smudge programs need to succeed in order to make their content usable. Otherwise their exit code is ignored. Note that this is more of a suggestion as we will always report errors as they happen as the driver API is streaming in nature, which makes soft-failures impossible unless the caller takes precautions.

Trait Implementations

impl Clone for Driver

fn clone(&self) -> Driver

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Driver

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

Formats the value using the given formatter.