Struct MutationResource 

pub struct MutationResource<V, T, E = QueryError> { /* private fields */ }

Available on crate feature core only.

A mutation resource that tracks the state of a single mutation.

V is the variables (input) type, T is the success output type, and E is the error type.

Implementations

impl<V, T, E> MutationResource<V, T, E>

pub fn new(retry_policy: RetryPolicy) -> Self

Create a new mutation resource with the given retry policy.

pub fn status(&self) -> MutationStatus

Current status.

pub fn data(&self) -> Option<&T>

Most recent successful data.

pub fn error(&self) -> Option<&E>

Most recent error.

pub fn variables(&self) -> Option<&V>

Variables for the current or most recent mutation.

pub fn retry_count(&self) -> u32

Current retry count.

pub fn cancelled_count(&self) -> u64

Number of times this mutation has been cancelled.

pub fn retry_policy(&self) -> &RetryPolicy

The retry policy.

pub fn set_retry_policy(&mut self, policy: RetryPolicy)

Set the retry policy.

Mirrors QueryResource::set_retry_policy / InfiniteQueryResource::set_retry_policy for API consistency.

pub fn is_loading(&self) -> bool

Whether the mutation is currently loading.

pub fn is_idle(&self) -> bool

Whether the mutation is idle.

pub fn is_success(&self) -> bool

Whether the mutation succeeded.

pub fn is_failure(&self) -> bool

Whether the mutation failed.

pub fn key(&self) -> Option<&QueryKey>

Optional query key for this mutation.

pub fn with_key(self, key: QueryKey) -> Self

Associate a query key with this mutation.

Forward-compatibility hook: the hook layer does not currently set a key on mutations, so key remains None in production. Kept for callers that want to tag a mutation with a key for diagnostics/invalidation.

pub fn begin(&mut self, variables: V)

Start a mutation with the given variables.

Transitions to Loading, stores variables, clears error, creates signal. Cancels any previous in-flight signal so a prior fetcher observes cancellation. Resets retry_count so each mutation invocation starts fresh, matching QueryResource’s behavior where the hook layer resets retries on success.

pub fn complete_success(&mut self, data: T)

Complete successfully.

pub fn complete_failure(&mut self, error: E)

Complete with failure.

Clears data so consumers do not see stale success data alongside a Failure status. Increments retry_count with saturating add to prevent wraparound.

pub fn should_retry(&self) -> bool

Whether another retry is allowed.

pub fn retry(&mut self) -> bool

Retry by transitioning back to Loading.

Only valid from Failure when retries remain. A fresh cancellation signal is created.

pub fn reset(&mut self)

Reset to idle, clearing everything.

pub fn signal(&self) -> Option<&QuerySignal>

The cancellation signal.

pub fn increment_retry(&mut self)

Increment the retry counter.

Used by the mutation retry loop to track how many attempts have been made without transitioning through a terminal Failure state.

pub fn prepare_retry(&mut self)

Prepare for a retry by refreshing the signal without transitioning through Failure.

Avoids a transient Failure status that would cause observers to see a brief Failure flash between retry attempts. The mutation stays in Loading state, the old signal is cancelled, and a fresh signal is created for the next attempt.

pub fn reset_retry_count(&mut self)

Reset the retry counter to zero.

Called on terminal failure so that retry_count is clean for the next mutation invocation.

pub fn cancel(&mut self, error: E)

Cancel the mutation.

Only has effect when the mutation is in Loading state. Returns without side effects if the mutation is already Idle, Success, or Failure, matching the QueryResource::cancel behavior where a no-op cancel is silent.

When effective, increments cancelled_count for diagnostics and sets status to Failure.

Trait Implementations

impl<V: Clone, T: Clone, E: Clone> Clone for MutationResource<V, T, E>

fn clone(&self) -> MutationResource<V, T, E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: Debug, T: Debug, E: Debug> Debug for MutationResource<V, T, E>

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

Formats the value using the given formatter.

impl<'de, V, T, E> Deserialize<'de> for MutationResource<V, T, E>

where V: Deserialize<'de>, T: Deserialize<'de>, E: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<V: Eq, T: Eq, E: Eq> Eq for MutationResource<V, T, E>

impl<V: 'static, T: 'static, E: 'static> ObservableResource for MutationResource<V, T, E>

Available on crate feature client only.

type Status = MutationStatus

fn observable_status(&self) -> MutationStatus

impl<V: PartialEq, T: PartialEq, E: PartialEq> PartialEq for MutationResource<V, T, E>

fn eq(&self, other: &MutationResource<V, T, E>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<V, T, E> Serialize for MutationResource<V, T, E>

where V: Serialize, T: Serialize, E: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<V: PartialEq, T: PartialEq, E: PartialEq> StructuralPartialEq for MutationResource<V, T, E>