Struct PullRequestFilter 

#[non_exhaustive]
pub struct PullRequestFilter {
    pub comment_control: CommentControl,
    pub invert_regex: bool,
    pub git_ref: Option<GitRef>,
    /* private fields */
}

PullRequestFilter contains filter properties for matching GitHub Pull Requests.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

comment_control: CommentControl

If CommentControl is enabled, depending on the setting, builds may not fire until a repository writer comments /gcbrun on a pull request or /gcbrun is in the pull request description. Only PR comments that contain /gcbrun will trigger builds.

If CommentControl is set to disabled, comments with /gcbrun from a user with repository write permission or above will still trigger builds to run.

invert_regex: bool

If true, branches that do NOT match the git_ref will trigger a build.

git_ref: Option<GitRef>

Target refs to match. A target ref is the git reference where the pull request will be applied.

Implementations

impl PullRequestFilter

pub fn new() -> Self

pub fn set_comment_control<T: Into<CommentControl>>(self, v: T) -> Self

Sets the value of comment_control.

pub fn set_invert_regex<T: Into<bool>>(self, v: T) -> Self

Sets the value of invert_regex.

pub fn set_git_ref<T: Into<Option<GitRef>>>(self, v: T) -> Self

Sets the value of git_ref.

Note that all the setters affecting git_ref are mutually exclusive.

pub fn branch(&self) -> Option<&String>

The value of git_ref if it holds a Branch, None if the field is not set or holds a different branch.

pub fn set_branch<T: Into<String>>(self, v: T) -> Self

Sets the value of git_ref to hold a Branch.

Note that all the setters affecting git_ref are mutually exclusive.

Trait Implementations

impl Clone for PullRequestFilter

fn clone(&self) -> PullRequestFilter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PullRequestFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PullRequestFilter

fn default() -> PullRequestFilter

Returns the “default value” for a type.

impl Message for PullRequestFilter

fn typename() -> &'static str

The typename of this message.

impl PartialEq for PullRequestFilter

fn eq(&self, other: &PullRequestFilter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PullRequestFilter