Skip to main content

WorkflowOps

Struct WorkflowOps 

Source
pub struct WorkflowOps<'a> { /* private fields */ }
Available on crate feature workflow only.
Expand description

High-level workflow helpers, scoped to a Repository.

Implementations§

Source§

impl<'a> WorkflowOps<'a>

Source

pub async fn feature_branch( &self, name: impl Into<String>, base: impl Into<String>, ) -> Result<()>

Create a new branch name starting at base and switch to it.

Equivalent to git checkout -b <name> <base>. Errors if a branch named name already exists.

Source

pub async fn commit_all(&self, message: impl Into<String>) -> Result<()>

Stage every change in the working tree and commit them with message.

Equivalent to git add -A followed by git commit -m <message>. Errors if there is nothing to commit.

Source

pub async fn sync(&self) -> Result<()>

Bring the current branch up to date with its upstream via rebase.

Equivalent to git pull --rebase. Errors if no upstream is configured or the rebase has conflicts.

Source

pub async fn squash_merge(&self, branch: impl Into<String>) -> Result<()>

Squash-merge branch into the current branch.

Equivalent to git merge --squash <branch>. The changes are staged but not committed — callers should follow up with commit_all or a raw commit to record them.

Trait Implementations§

Source§

impl<'a> Debug for WorkflowOps<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for WorkflowOps<'a>

§

impl<'a> RefUnwindSafe for WorkflowOps<'a>

§

impl<'a> Send for WorkflowOps<'a>

§

impl<'a> Sync for WorkflowOps<'a>

§

impl<'a> Unpin for WorkflowOps<'a>

§

impl<'a> UnsafeUnpin for WorkflowOps<'a>

§

impl<'a> UnwindSafe for WorkflowOps<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more