#[non_exhaustive]pub struct CreateCommitInput {
pub repository_name: Option<String>,
pub branch_name: Option<String>,
pub parent_commit_id: Option<String>,
pub author_name: Option<String>,
pub email: Option<String>,
pub commit_message: Option<String>,
pub keep_empty_folders: Option<bool>,
pub put_files: Option<Vec<PutFileEntry>>,
pub delete_files: Option<Vec<DeleteFileEntry>>,
pub set_file_modes: Option<Vec<SetFileModeEntry>>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.repository_name: Option<String>
The name of the repository where you create the commit.
branch_name: Option<String>
The name of the branch where you create the commit.
parent_commit_id: Option<String>
The ID of the commit that is the parent of the commit you create. Not required if this is an empty repository.
The name of the author who created the commit. This information is used as both the author and committer for the commit.
email: Option<String>
The email address of the person who created the commit.
commit_message: Option<String>
The commit message you want to include in the commit. Commit messages are limited to 256 KB. If no message is specified, a default message is used.
keep_empty_folders: Option<bool>
If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a ..gitkeep file is created for empty folders. The default is false.
put_files: Option<Vec<PutFileEntry>>
The files to add or update in this commit.
delete_files: Option<Vec<DeleteFileEntry>>
The files to delete in this commit. These files still exist in earlier commits.
set_file_modes: Option<Vec<SetFileModeEntry>>
The file modes to update for files in this commit.
Implementations§
Source§impl CreateCommitInput
impl CreateCommitInput
Sourcepub fn repository_name(&self) -> Option<&str>
pub fn repository_name(&self) -> Option<&str>
The name of the repository where you create the commit.
Sourcepub fn branch_name(&self) -> Option<&str>
pub fn branch_name(&self) -> Option<&str>
The name of the branch where you create the commit.
Sourcepub fn parent_commit_id(&self) -> Option<&str>
pub fn parent_commit_id(&self) -> Option<&str>
The ID of the commit that is the parent of the commit you create. Not required if this is an empty repository.
The name of the author who created the commit. This information is used as both the author and committer for the commit.
Sourcepub fn commit_message(&self) -> Option<&str>
pub fn commit_message(&self) -> Option<&str>
The commit message you want to include in the commit. Commit messages are limited to 256 KB. If no message is specified, a default message is used.
Sourcepub fn keep_empty_folders(&self) -> Option<bool>
pub fn keep_empty_folders(&self) -> Option<bool>
If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a ..gitkeep file is created for empty folders. The default is false.
Sourcepub fn put_files(&self) -> &[PutFileEntry]
pub fn put_files(&self) -> &[PutFileEntry]
The files to add or update in this commit.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .put_files.is_none()
.
Sourcepub fn delete_files(&self) -> &[DeleteFileEntry]
pub fn delete_files(&self) -> &[DeleteFileEntry]
The files to delete in this commit. These files still exist in earlier commits.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .delete_files.is_none()
.
Sourcepub fn set_file_modes(&self) -> &[SetFileModeEntry]
pub fn set_file_modes(&self) -> &[SetFileModeEntry]
The file modes to update for files in this commit.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .set_file_modes.is_none()
.
Source§impl CreateCommitInput
impl CreateCommitInput
Sourcepub fn builder() -> CreateCommitInputBuilder
pub fn builder() -> CreateCommitInputBuilder
Creates a new builder-style object to manufacture CreateCommitInput
.
Trait Implementations§
Source§impl Clone for CreateCommitInput
impl Clone for CreateCommitInput
Source§fn clone(&self) -> CreateCommitInput
fn clone(&self) -> CreateCommitInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateCommitInput
impl Debug for CreateCommitInput
Source§impl PartialEq for CreateCommitInput
impl PartialEq for CreateCommitInput
impl StructuralPartialEq for CreateCommitInput
Auto Trait Implementations§
impl Freeze for CreateCommitInput
impl RefUnwindSafe for CreateCommitInput
impl Send for CreateCommitInput
impl Sync for CreateCommitInput
impl Unpin for CreateCommitInput
impl UnwindSafe for CreateCommitInput
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);