Enum NotesAction 

pub enum NotesAction {
    Add {
        object: Option<String>,
        message: Option<String>,
        message_file: Option<PathBuf>,
        force: bool,
        allow_empty: bool,
        no_stripspace: bool,
    },
    Append {
        object: Option<String>,
        message: Option<String>,
        message_file: Option<PathBuf>,
        allow_empty: bool,
        no_stripspace: bool,
    },
    Copy {
        from: String,
        to: String,
        force: bool,
    },
    Show {
        object: Option<String>,
    },
    List {
        object: Option<String>,
    },
    Remove {
        object: Option<String>,
        ignore_missing: bool,
    },
    Prune {
        dry_run: bool,
        verbose: bool,
    },
}

Actions supported by git notes.

Variants

Add

git notes add [-f] [--allow-empty] [-m <msg> | -F <file>] [<object>].

Fields

object: Option<String>

Target object (defaults to HEAD when None).

message: Option<String>

-m <msg> note contents as a string.

message_file: Option<PathBuf>

-F <file> note contents read from a file.

force: bool

-f replace an existing note.

allow_empty: bool

--allow-empty store a note even if it is empty.

no_stripspace: bool

--no-stripspace keep the payload byte-for-byte.

Append

git notes append [--allow-empty] [-m <msg> | -F <file>] [<object>].

Fields

object: Option<String>

Target object (defaults to HEAD when None).

message: Option<String>

-m <msg> text to append.

message_file: Option<PathBuf>

-F <file> payload to append, read from a file.

allow_empty: bool

--allow-empty store a note even if it is empty.

no_stripspace: bool

--no-stripspace keep the payload byte-for-byte.

Copy

git notes copy [-f] <from-object> <to-object>.

Fields

from: String

Object to copy the note from.

to: String

Object to copy the note to.

force: bool

-f overwrite an existing note on the target.

Show

git notes show [<object>].

Exits non-zero when no note exists for the object — surfaced as a clean Error::CommandFailed, never swallowed.

Fields

object: Option<String>

Target object (defaults to HEAD when None).

List

git notes list [<object>].

Fields

object: Option<String>

Restrict to a single object (otherwise lists every note).

Remove

git notes remove [--ignore-missing] [<object>].

Fields

object: Option<String>

Target object (defaults to HEAD when None).

ignore_missing: bool

--ignore-missing exit zero when there is no note to remove.

Prune

git notes prune [-n] [-v] — drop notes for non-existent objects.

Fields

dry_run: bool

-n dry run: report without removing.

verbose: bool

-v report pruned objects.

Trait Implementations

impl Clone for NotesAction

fn clone(&self) -> NotesAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NotesAction

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

Formats the value using the given formatter.