Struct git2::EmailCreateOptions

pub struct EmailCreateOptions { /* private fields */ }

Options for controlling the formatting of the generated e-mail.

Implementations

impl EmailCreateOptions

pub fn new() -> Self

Creates a new set of email create options

By default, options include rename detection and binary diffs to match git format-patch.

pub fn omit_numbers(&mut self, omit: bool) -> &mut Self

Flag indicating whether patch numbers are included in the subject prefix.

pub fn always_number(&mut self, always: bool) -> &mut Self

Flag indicating whether numbers included in the subject prefix even when the patch is for a single commit (1/1).

pub fn ignore_renames(&mut self, ignore: bool) -> &mut Self

Flag indicating whether rename or similarity detection are ignored.

pub fn diff_options(&mut self) -> &mut DiffOptions

Get mutable access to DiffOptions that are used for creating diffs.

pub fn diff_find_options(&mut self) -> &mut DiffFindOptions

Get mutable access to DiffFindOptions that are used for finding similarities within diffs.

pub fn subject_prefix<T: IntoCString>(&mut self, t: T) -> &mut Self

Set the subject prefix

The default value for this is “PATCH”. If set to an empty string (“”) then only the patch numbers will be shown in the prefix. If the subject_prefix is empty and patch numbers are not being shown, the prefix will be omitted entirely.

pub fn start_number(&mut self, number: usize) -> &mut Self

Set the starting patch number; this cannot be 0.

The default value for this is 1.

pub fn reroll_number(&mut self, number: usize) -> &mut Self

Set the “re-roll” number.

The default value for this is 0 (no re-roll).

Trait Implementations

impl Default for EmailCreateOptions

fn default() -> Self

Returns the “default value” for a type.