Skip to main content

WithDocResult

Struct WithDocResult 

Source
pub struct WithDocResult<T> {
    pub value: T,
    pub actor_result: DocActorResult,
}
Expand description

Result of a document operation that includes both the closure result and any side effects.

When modifying a document via with_document, the operation may generate side effects like storage operations (saving changes) or messages to be sent to connected peers. This type encapsulates both the result of the user’s closure and the side effects that need to be executed.

§Type Parameters

  • T - The type returned by the closure passed to with_document

§Example

let result = actor.with_document(|doc| {
    // Modify document and return some value
    doc.put_object(automerge::ROOT, "key", "value").unwrap()
})?;

// Access the closure result
let object_id = result.value;

// Execute any side effects
for io_task in result.actor_result.io_tasks {
    // Execute storage operations
}
for message in result.actor_result.outgoing_messages {
    // Send messages to main Samod
}

Fields§

§value: T

The result returned by the closure passed to with_document

§actor_result: DocActorResult

Any side effects generated by the document operation (IO tasks, messages, etc.)

Implementations§

Source§

impl<T> WithDocResult<T>

Source

pub fn new(value: T) -> Self

Creates a new result with the given value and empty side effects

Source

pub fn with_side_effects(value: T, actor_result: DocActorResult) -> Self

Creates a new result with the given value and actor result

Trait Implementations§

Source§

impl<T: Debug> Debug for WithDocResult<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for WithDocResult<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for WithDocResult<T>
where T: RefUnwindSafe,

§

impl<T> Send for WithDocResult<T>
where T: Send,

§

impl<T> Sync for WithDocResult<T>
where T: Sync,

§

impl<T> Unpin for WithDocResult<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for WithDocResult<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for WithDocResult<T>
where T: UnwindSafe,

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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