#[non_exhaustive]pub struct CommitBuilder { /* private fields */ }
Expand description
A builder for Commit
.
Implementations§
Source§impl CommitBuilder
impl CommitBuilder
Sourcepub fn commit_id(self, input: impl Into<String>) -> Self
pub fn commit_id(self, input: impl Into<String>) -> Self
The full SHA ID of the specified commit.
Sourcepub fn set_commit_id(self, input: Option<String>) -> Self
pub fn set_commit_id(self, input: Option<String>) -> Self
The full SHA ID of the specified commit.
Sourcepub fn get_commit_id(&self) -> &Option<String>
pub fn get_commit_id(&self) -> &Option<String>
The full SHA ID of the specified commit.
Sourcepub fn tree_id(self, input: impl Into<String>) -> Self
pub fn tree_id(self, input: impl Into<String>) -> Self
Tree information for the specified commit.
Sourcepub fn set_tree_id(self, input: Option<String>) -> Self
pub fn set_tree_id(self, input: Option<String>) -> Self
Tree information for the specified commit.
Sourcepub fn get_tree_id(&self) -> &Option<String>
pub fn get_tree_id(&self) -> &Option<String>
Tree information for the specified commit.
Sourcepub fn parents(self, input: impl Into<String>) -> Self
pub fn parents(self, input: impl Into<String>) -> Self
Appends an item to parents
.
To override the contents of this collection use set_parents
.
A list of parent commits for the specified commit. Each parent commit ID is the full commit ID.
Sourcepub fn set_parents(self, input: Option<Vec<String>>) -> Self
pub fn set_parents(self, input: Option<Vec<String>>) -> Self
A list of parent commits for the specified commit. Each parent commit ID is the full commit ID.
Sourcepub fn get_parents(&self) -> &Option<Vec<String>>
pub fn get_parents(&self) -> &Option<Vec<String>>
A list of parent commits for the specified commit. Each parent commit ID is the full commit ID.
Sourcepub fn message(self, input: impl Into<String>) -> Self
pub fn message(self, input: impl Into<String>) -> Self
The commit message associated with the specified commit.
Sourcepub fn set_message(self, input: Option<String>) -> Self
pub fn set_message(self, input: Option<String>) -> Self
The commit message associated with the specified commit.
Sourcepub fn get_message(&self) -> &Option<String>
pub fn get_message(&self) -> &Option<String>
The commit message associated with the specified commit.
Information about the author of the specified commit. Information includes the date in timestamp format with GMT offset, the name of the author, and the email address for the author, as configured in Git.
Information about the author of the specified commit. Information includes the date in timestamp format with GMT offset, the name of the author, and the email address for the author, as configured in Git.
Information about the author of the specified commit. Information includes the date in timestamp format with GMT offset, the name of the author, and the email address for the author, as configured in Git.
Sourcepub fn committer(self, input: UserInfo) -> Self
pub fn committer(self, input: UserInfo) -> Self
Information about the person who committed the specified commit, also known as the committer. Information includes the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured in Git.
For more information about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git by Scott Chacon and Ben Straub.
Sourcepub fn set_committer(self, input: Option<UserInfo>) -> Self
pub fn set_committer(self, input: Option<UserInfo>) -> Self
Information about the person who committed the specified commit, also known as the committer. Information includes the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured in Git.
For more information about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git by Scott Chacon and Ben Straub.
Sourcepub fn get_committer(&self) -> &Option<UserInfo>
pub fn get_committer(&self) -> &Option<UserInfo>
Information about the person who committed the specified commit, also known as the committer. Information includes the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured in Git.
For more information about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git by Scott Chacon and Ben Straub.
Sourcepub fn additional_data(self, input: impl Into<String>) -> Self
pub fn additional_data(self, input: impl Into<String>) -> Self
Any other data associated with the specified commit.
Sourcepub fn set_additional_data(self, input: Option<String>) -> Self
pub fn set_additional_data(self, input: Option<String>) -> Self
Any other data associated with the specified commit.
Sourcepub fn get_additional_data(&self) -> &Option<String>
pub fn get_additional_data(&self) -> &Option<String>
Any other data associated with the specified commit.
Trait Implementations§
Source§impl Clone for CommitBuilder
impl Clone for CommitBuilder
Source§fn clone(&self) -> CommitBuilder
fn clone(&self) -> CommitBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CommitBuilder
impl Debug for CommitBuilder
Source§impl Default for CommitBuilder
impl Default for CommitBuilder
Source§fn default() -> CommitBuilder
fn default() -> CommitBuilder
Source§impl PartialEq for CommitBuilder
impl PartialEq for CommitBuilder
impl StructuralPartialEq for CommitBuilder
Auto Trait Implementations§
impl Freeze for CommitBuilder
impl RefUnwindSafe for CommitBuilder
impl Send for CommitBuilder
impl Sync for CommitBuilder
impl Unpin for CommitBuilder
impl UnwindSafe for CommitBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);