Skip to main content

WorkflowSideEffects

Struct WorkflowSideEffects 

Source
pub struct WorkflowSideEffects { /* private fields */ }
Expand description

Shared mutable store for a single workflow run.

Implementations§

Source§

impl WorkflowSideEffects

Source

pub fn new() -> Self

Empty store.

Source

pub fn shared() -> Arc<Self>

Shared handle.

Source

pub fn set_git_cwd(&self, cwd: impl Into<PathBuf>)

Enable git operations rooted at cwd (must be a git work tree).

Source

pub fn register_template( &self, name: impl Into<String>, body: impl Into<String>, )

Register a named template body. Placeholders use {{key}}.

Source

pub fn write_scratch( &self, name: &str, content: String, ) -> Result<String, HostError>

Write scratch content; returns virtual path scratch/{name}.

§Errors

Empty name or oversized content.

Source

pub fn read_scratch(&self, name: &str) -> Result<String, HostError>

Read scratch content.

§Errors

Missing file.

Source

pub fn render_template( &self, name: &str, vars: &Value, ) -> Result<String, HostError>

Render a registered template with string vars from a JSON object.

§Errors

Missing template or non-object vars.

Source

pub fn scratch_len(&self) -> usize

Number of scratch entries (tests).

Source

pub fn git_diff_since(&self, commit: &str) -> Result<String, HostError>

Run git diff <commit> (commit → working tree) in the configured cwd.

Optional capability: requires Self::set_git_cwd. Prefer leaving git disabled unless the host product needs repository context.

§Errors

Missing cwd, invalid commit string, or git failure.

Trait Implementations§

Source§

impl Debug for WorkflowSideEffects

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WorkflowSideEffects

Source§

fn default() -> WorkflowSideEffects

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> Same for T

Source§

type Output = T

Should always be Self
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