#[non_exhaustive]pub struct PutFileEntryBuilder { /* private fields */ }
Expand description
A builder for PutFileEntry
.
Implementations§
Source§impl PutFileEntryBuilder
impl PutFileEntryBuilder
Sourcepub fn file_path(self, input: impl Into<String>) -> Self
pub fn file_path(self, input: impl Into<String>) -> Self
The full path to the file in the repository, including the name of the file.
This field is required.Sourcepub fn set_file_path(self, input: Option<String>) -> Self
pub fn set_file_path(self, input: Option<String>) -> Self
The full path to the file in the repository, including the name of the file.
Sourcepub fn get_file_path(&self) -> &Option<String>
pub fn get_file_path(&self) -> &Option<String>
The full path to the file in the repository, including the name of the file.
Sourcepub fn file_mode(self, input: FileModeTypeEnum) -> Self
pub fn file_mode(self, input: FileModeTypeEnum) -> Self
The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.
Sourcepub fn set_file_mode(self, input: Option<FileModeTypeEnum>) -> Self
pub fn set_file_mode(self, input: Option<FileModeTypeEnum>) -> Self
The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.
Sourcepub fn get_file_mode(&self) -> &Option<FileModeTypeEnum>
pub fn get_file_mode(&self) -> &Option<FileModeTypeEnum>
The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.
Sourcepub fn file_content(self, input: Blob) -> Self
pub fn file_content(self, input: Blob) -> Self
The content of the file, if a source file is not specified.
Sourcepub fn set_file_content(self, input: Option<Blob>) -> Self
pub fn set_file_content(self, input: Option<Blob>) -> Self
The content of the file, if a source file is not specified.
Sourcepub fn get_file_content(&self) -> &Option<Blob>
pub fn get_file_content(&self) -> &Option<Blob>
The content of the file, if a source file is not specified.
Sourcepub fn source_file(self, input: SourceFileSpecifier) -> Self
pub fn source_file(self, input: SourceFileSpecifier) -> Self
The name and full path of the file that contains the changes you want to make as part of the commit, if you are not providing the file content directly.
Sourcepub fn set_source_file(self, input: Option<SourceFileSpecifier>) -> Self
pub fn set_source_file(self, input: Option<SourceFileSpecifier>) -> Self
The name and full path of the file that contains the changes you want to make as part of the commit, if you are not providing the file content directly.
Sourcepub fn get_source_file(&self) -> &Option<SourceFileSpecifier>
pub fn get_source_file(&self) -> &Option<SourceFileSpecifier>
The name and full path of the file that contains the changes you want to make as part of the commit, if you are not providing the file content directly.
Sourcepub fn build(self) -> Result<PutFileEntry, BuildError>
pub fn build(self) -> Result<PutFileEntry, BuildError>
Consumes the builder and constructs a PutFileEntry
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for PutFileEntryBuilder
impl Clone for PutFileEntryBuilder
Source§fn clone(&self) -> PutFileEntryBuilder
fn clone(&self) -> PutFileEntryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PutFileEntryBuilder
impl Debug for PutFileEntryBuilder
Source§impl Default for PutFileEntryBuilder
impl Default for PutFileEntryBuilder
Source§fn default() -> PutFileEntryBuilder
fn default() -> PutFileEntryBuilder
Source§impl PartialEq for PutFileEntryBuilder
impl PartialEq for PutFileEntryBuilder
impl StructuralPartialEq for PutFileEntryBuilder
Auto Trait Implementations§
impl Freeze for PutFileEntryBuilder
impl RefUnwindSafe for PutFileEntryBuilder
impl Send for PutFileEntryBuilder
impl Sync for PutFileEntryBuilder
impl Unpin for PutFileEntryBuilder
impl UnwindSafe for PutFileEntryBuilder
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);