Struct WorkflowDispatch 

#[non_exhaustive]
pub struct WorkflowDispatch {
    pub workflow: String,
    pub git_ref: Option<String>,
    pub fields: Vec<(String, String)>,
}

Options for GitHubApi::workflow_dispatch (gh workflow run), which fires a workflow_dispatch event for a workflow that declares an on: workflow_dispatch trigger.

#[non_exhaustive], so build it through WorkflowDispatch::new (the workflow selector) and the chained git_ref / field setters rather than a struct literal — the ≥2 options → builder rule (a target ref and any number of inputs) the crate applies to its multi-option commands.

Inputs are emitted as -f/--raw-field key=value (the raw string form), not gh’s -F/--field: the latter interprets a value beginning with @ as a file to read (gh help api’s @ syntax), so a caller-supplied value like @/etc/passwd would exfiltrate a file into the dispatch. --raw-field treats every value as a literal string, so an arbitrary input value (including a leading - or @) is passed verbatim and safely.

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.

workflow: String

The workflow to run — its file name (ci.yml / release.yml) or its display name (gh’s [<workflow-id> | <workflow-name>] positional). A bare positional, so it is flag-injection guarded (a leading - / empty value is refused before spawning), like release_view’s tag.

git_ref: Option<String>

The branch or tag whose version of the workflow file to run (--ref); None runs the version on the repository’s default branch. Rides in a flag-VALUE slot (gh consumes the next token verbatim, like --branch), so no positional guard applies.

fields: Vec<(String, String)>

workflow_dispatch inputs, as ordered (key, value) pairs. Each is emitted as --raw-field key=value (see the type-level note on why --raw-field, not --field). Keys must be non-empty after trimming and cannot contain = or NUL; values can be any string (a leading -/@ is safe in this flag-VALUE slot).

Implementations

impl WorkflowDispatch

pub fn new(workflow: impl Into<String>) -> Self

Dispatch workflow on the repository’s default branch with no inputs. Chain git_ref to target a branch/tag and field to add inputs.

pub fn git_ref(self, git_ref: impl Into<String>) -> Self

Set the branch or tag whose version of the workflow file to run (--ref). (Named git_ref because ref is a Rust keyword.)

pub fn field(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add one workflow_dispatch input (--raw-field key=value). Call it once per input; inputs are emitted in the order added.

Trait Implementations

impl Clone for WorkflowDispatch

fn clone(&self) -> WorkflowDispatch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowDispatch

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

Formats the value using the given formatter.