#[non_exhaustive]pub struct PullRequestTarget {
pub repository_name: Option<String>,
pub source_reference: Option<String>,
pub destination_reference: Option<String>,
pub destination_commit: Option<String>,
pub source_commit: Option<String>,
pub merge_base: Option<String>,
pub merge_metadata: Option<MergeMetadata>,
}
Expand description
Returns information about a pull request target.
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 that contains the pull request source and destination branches.
source_reference: Option<String>
The branch of the repository that contains the changes for the pull request. Also known as the source branch.
destination_reference: Option<String>
The branch of the repository where the pull request changes are merged. Also known as the destination branch.
destination_commit: 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.
source_commit: 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.
merge_base: Option<String>
The commit ID of the most recent commit that the source branch and the destination branch have in common.
merge_metadata: Option<MergeMetadata>
Returns metadata about the state of the merge, including whether the merge has been made.
Implementations§
Source§impl PullRequestTarget
impl PullRequestTarget
Sourcepub fn repository_name(&self) -> Option<&str>
pub fn repository_name(&self) -> Option<&str>
The name of the repository that contains the pull request source and destination branches.
Sourcepub fn source_reference(&self) -> Option<&str>
pub fn source_reference(&self) -> Option<&str>
The branch of the repository that contains the changes for the pull request. Also known as the source branch.
Sourcepub fn destination_reference(&self) -> Option<&str>
pub fn destination_reference(&self) -> Option<&str>
The branch of the repository where the pull request changes are merged. Also known as the destination branch.
Sourcepub fn destination_commit(&self) -> Option<&str>
pub fn destination_commit(&self) -> Option<&str>
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) -> Option<&str>
pub fn source_commit(&self) -> Option<&str>
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) -> Option<&str>
pub fn merge_base(&self) -> Option<&str>
The commit ID of the most recent commit that the source branch and the destination branch have in common.
Sourcepub fn merge_metadata(&self) -> Option<&MergeMetadata>
pub fn merge_metadata(&self) -> Option<&MergeMetadata>
Returns metadata about the state of the merge, including whether the merge has been made.
Source§impl PullRequestTarget
impl PullRequestTarget
Sourcepub fn builder() -> PullRequestTargetBuilder
pub fn builder() -> PullRequestTargetBuilder
Creates a new builder-style object to manufacture PullRequestTarget
.
Trait Implementations§
Source§impl Clone for PullRequestTarget
impl Clone for PullRequestTarget
Source§fn clone(&self) -> PullRequestTarget
fn clone(&self) -> PullRequestTarget
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 PullRequestTarget
impl Debug for PullRequestTarget
Source§impl PartialEq for PullRequestTarget
impl PartialEq for PullRequestTarget
impl StructuralPartialEq for PullRequestTarget
Auto Trait Implementations§
impl Freeze for PullRequestTarget
impl RefUnwindSafe for PullRequestTarget
impl Send for PullRequestTarget
impl Sync for PullRequestTarget
impl Unpin for PullRequestTarget
impl UnwindSafe for PullRequestTarget
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);