#[non_exhaustive]pub struct PullRequestTargetBuilder { /* private fields */ }
Expand description
A builder for PullRequestTarget
.
Implementations§
Source§impl PullRequestTargetBuilder
impl PullRequestTargetBuilder
Sourcepub fn repository_name(self, input: impl Into<String>) -> Self
pub fn repository_name(self, input: impl Into<String>) -> Self
The name of the repository that contains the pull request source and destination branches.
Sourcepub fn set_repository_name(self, input: Option<String>) -> Self
pub fn set_repository_name(self, input: Option<String>) -> Self
The name of the repository that contains the pull request source and destination branches.
Sourcepub fn get_repository_name(&self) -> &Option<String>
pub fn get_repository_name(&self) -> &Option<String>
The name of the repository that contains the pull request source and destination branches.
Sourcepub fn source_reference(self, input: impl Into<String>) -> Self
pub fn source_reference(self, input: impl Into<String>) -> Self
The branch of the repository that contains the changes for the pull request. Also known as the source branch.
Sourcepub fn set_source_reference(self, input: Option<String>) -> Self
pub fn set_source_reference(self, input: Option<String>) -> Self
The branch of the repository that contains the changes for the pull request. Also known as the source branch.
Sourcepub fn get_source_reference(&self) -> &Option<String>
pub fn get_source_reference(&self) -> &Option<String>
The branch of the repository that contains the changes for the pull request. Also known as the source branch.
Sourcepub fn destination_reference(self, input: impl Into<String>) -> Self
pub fn destination_reference(self, input: impl Into<String>) -> Self
The branch of the repository where the pull request changes are merged. Also known as the destination branch.
Sourcepub fn set_destination_reference(self, input: Option<String>) -> Self
pub fn set_destination_reference(self, input: Option<String>) -> Self
The branch of the repository where the pull request changes are merged. Also known as the destination branch.
Sourcepub fn get_destination_reference(&self) -> &Option<String>
pub fn get_destination_reference(&self) -> &Option<String>
The branch of the repository where the pull request changes are merged. Also known as the destination branch.
Sourcepub fn destination_commit(self, input: impl Into<String>) -> Self
pub fn destination_commit(self, input: impl Into<String>) -> Self
The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.
Sourcepub fn set_destination_commit(self, input: Option<String>) -> Self
pub fn set_destination_commit(self, input: Option<String>) -> Self
The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.
Sourcepub fn get_destination_commit(&self) -> &Option<String>
pub fn get_destination_commit(&self) -> &Option<String>
The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.
Sourcepub fn source_commit(self, input: impl Into<String>) -> Self
pub fn source_commit(self, input: impl Into<String>) -> Self
The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID changes to reflect the new tip of the branch.
Sourcepub fn set_source_commit(self, input: Option<String>) -> Self
pub fn set_source_commit(self, input: Option<String>) -> Self
The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID changes to reflect the new tip of the branch.
Sourcepub fn get_source_commit(&self) -> &Option<String>
pub fn get_source_commit(&self) -> &Option<String>
The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID changes to reflect the new tip of the branch.
Sourcepub fn merge_base(self, input: impl Into<String>) -> Self
pub fn merge_base(self, input: impl Into<String>) -> Self
The commit ID of the most recent commit that the source branch and the destination branch have in common.
Sourcepub fn set_merge_base(self, input: Option<String>) -> Self
pub fn set_merge_base(self, input: Option<String>) -> Self
The commit ID of the most recent commit that the source branch and the destination branch have in common.
Sourcepub fn get_merge_base(&self) -> &Option<String>
pub fn get_merge_base(&self) -> &Option<String>
The commit ID of the most recent commit that the source branch and the destination branch have in common.
Sourcepub fn merge_metadata(self, input: MergeMetadata) -> Self
pub fn merge_metadata(self, input: MergeMetadata) -> Self
Returns metadata about the state of the merge, including whether the merge has been made.
Sourcepub fn set_merge_metadata(self, input: Option<MergeMetadata>) -> Self
pub fn set_merge_metadata(self, input: Option<MergeMetadata>) -> Self
Returns metadata about the state of the merge, including whether the merge has been made.
Sourcepub fn get_merge_metadata(&self) -> &Option<MergeMetadata>
pub fn get_merge_metadata(&self) -> &Option<MergeMetadata>
Returns metadata about the state of the merge, including whether the merge has been made.
Sourcepub fn build(self) -> PullRequestTarget
pub fn build(self) -> PullRequestTarget
Consumes the builder and constructs a PullRequestTarget
.
Trait Implementations§
Source§impl Clone for PullRequestTargetBuilder
impl Clone for PullRequestTargetBuilder
Source§fn clone(&self) -> PullRequestTargetBuilder
fn clone(&self) -> PullRequestTargetBuilder
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 PullRequestTargetBuilder
impl Debug for PullRequestTargetBuilder
Source§impl Default for PullRequestTargetBuilder
impl Default for PullRequestTargetBuilder
Source§fn default() -> PullRequestTargetBuilder
fn default() -> PullRequestTargetBuilder
Source§impl PartialEq for PullRequestTargetBuilder
impl PartialEq for PullRequestTargetBuilder
Source§fn eq(&self, other: &PullRequestTargetBuilder) -> bool
fn eq(&self, other: &PullRequestTargetBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for PullRequestTargetBuilder
Auto Trait Implementations§
impl Freeze for PullRequestTargetBuilder
impl RefUnwindSafe for PullRequestTargetBuilder
impl Send for PullRequestTargetBuilder
impl Sync for PullRequestTargetBuilder
impl Unpin for PullRequestTargetBuilder
impl UnwindSafe for PullRequestTargetBuilder
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);