Struct OwnedTransaction 

pub struct OwnedTransaction { /* private fields */ }

A transaction that owns the Automerge document.

Like super::Transaction, this groups operations into a single change. The difference is ownership: Transaction<'a> borrows &'a mut Automerge, while OwnedTransaction consumes it, making the type 'static and Send. This is useful when lifetimes cannot be tracked across an API boundary (e.g. FFI, async runtimes, or storing a transaction in a struct that must be 'static).

Created via Automerge::into_transaction.

Implementations

impl OwnedTransaction

pub fn hash_for_opid(&self, opid: &ExId) -> Option<ChangeHash>

Get the hash of the change that contains the given opid.

Returns none if the opid:

• is the root object id
• does not exist in this document
• is for an operation in this transaction

pub fn get_heads(&self) -> Vec<ChangeHash>

Get the heads of the document before this transaction was started.

pub fn commit(self) -> (Automerge, Option<ChangeHash>, PatchLog)

Commit the transaction, returning the document, commit hash, and patch log.

Unlike super::Transaction::commit, no PatchLog clone is needed — it is moved out.

pub fn commit_with( self, options: CommitOptions, ) -> (Automerge, Option<ChangeHash>, PatchLog)

Commit with options.

pub fn rollback(self) -> (Automerge, usize)

Rollback the transaction, returning the document and number of cancelled ops.

Trait Implementations

impl Debug for OwnedTransaction

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

Formats the value using the given formatter.

impl ReadDoc for OwnedTransaction

fn keys<O>(&self, obj: O) -> Keys<'_>

where O: AsRef<ExId>,

Get the keys of the object obj.

fn keys_at<O>(&self, obj: O, heads: &[ChangeHash]) -> Keys<'_>

where O: AsRef<ExId>,

Get the keys of the object obj as at heads

fn iter_at<O>(&self, obj: O, heads: Option<&[ChangeHash]>) -> DocIter<'_>

where O: AsRef<ExId>,

Iterate over the object obj as at heads

fn map_range<'b, O, R>(&'b self, obj: O, range: R) -> MapRange<'b>

where O: AsRef<ExId>, R: RangeBounds<String> + 'b,

Iterate over the keys and values of the map obj in the given range.

fn map_range_at<'b, O, R>( &'b self, obj: O, range: R, heads: &[ChangeHash], ) -> MapRange<'b>

where O: AsRef<ExId>, R: RangeBounds<String> + 'b,

Iterate over the keys and values of the map obj in the given range as at heads

fn list_range<O, R>(&self, obj: O, range: R) -> ListRange<'_>

where O: AsRef<ExId>, R: RangeBounds<usize>,

Iterate over the indexes and values of the list or text obj in the given range.

fn list_range_at<O, R>( &self, obj: O, range: R, heads: &[ChangeHash], ) -> ListRange<'_>

where O: AsRef<ExId>, R: RangeBounds<usize>,

Iterate over the indexes and values of the list or text obj in the given range as at heads

fn values<O>(&self, obj: O) -> Values<'_>

where O: AsRef<ExId>,

Iterate over the values in a map, list, or text object

fn values_at<O>(&self, obj: O, heads: &[ChangeHash]) -> Values<'_>

where O: AsRef<ExId>,

Iterate over the values in a map, list, or text object as at heads

fn length<O>(&self, obj: O) -> usize

where O: AsRef<ExId>,

Get the length of the given object.

fn length_at<O>(&self, obj: O, heads: &[ChangeHash]) -> usize

where O: AsRef<ExId>,

Get the length of the given object as at heads

fn object_type<O>(&self, obj: O) -> Result<ObjType, AutomergeError>

where O: AsRef<ExId>,

Get the type of this object, if it is an object.

fn text<O>(&self, obj: O) -> Result<String, AutomergeError>

where O: AsRef<ExId>,

Get the string represented by the given text object.

fn text_at<O>( &self, obj: O, heads: &[ChangeHash], ) -> Result<String, AutomergeError>

where O: AsRef<ExId>,

Get the string represented by the given text object as at heads, see Self::text()

fn spans<O>(&self, obj: O) -> Result<Spans<'_>, AutomergeError>

where O: AsRef<ExId>,

Return the sequence of text and block markers in the text object obj

fn spans_at<O>( &self, obj: O, heads: &[ChangeHash], ) -> Result<Spans<'_>, AutomergeError>

where O: AsRef<ExId>,

Return the sequence of text and block markers in the text object obj as at heads

fn get_cursor<O, I>( &self, obj: O, position: I, at: Option<&[ChangeHash]>, ) -> Result<Cursor, AutomergeError>

where O: AsRef<ExId>, I: Into<CursorPosition>,

Obtain the stable address (Cursor) for a usize position in a Sequence (either ObjType::List or ObjType::Text).

fn get_cursor_moving<O, I>( &self, obj: O, position: I, at: Option<&[ChangeHash]>, move_cursor: MoveCursor, ) -> Result<Cursor, AutomergeError>

where O: AsRef<ExId>, I: Into<CursorPosition>,

Obtain the stable address (Cursor) for a usize position in a Sequence (either ObjType::List or ObjType::Text).

fn get_cursor_position<O>( &self, obj: O, address: &Cursor, at: Option<&[ChangeHash]>, ) -> Result<usize, AutomergeError>

where O: AsRef<ExId>,

Translate Cursor in a Sequence into an absolute position of type usize.

fn marks<O>(&self, obj: O) -> Result<Vec<Mark>, AutomergeError>

where O: AsRef<ExId>,

Get all marks on a current sequence

fn marks_at<O>( &self, obj: O, heads: &[ChangeHash], ) -> Result<Vec<Mark>, AutomergeError>

where O: AsRef<ExId>,

Get all marks on a sequence at a given heads

fn hydrate<O>( &self, obj: O, heads: Option<&[ChangeHash]>, ) -> Result<Value, AutomergeError>

where O: AsRef<ExId>,

fn get_marks<O>( &self, obj: O, index: usize, heads: Option<&[ChangeHash]>, ) -> Result<MarkSet, AutomergeError>

where O: AsRef<ExId>,

fn get<O, P>( &self, obj: O, prop: P, ) -> Result<Option<(Value<'_>, ExId)>, AutomergeError>

where O: AsRef<ExId>, P: Into<Prop>,

Get a value out of the document.

fn get_at<O, P>( &self, obj: O, prop: P, heads: &[ChangeHash], ) -> Result<Option<(Value<'_>, ExId)>, AutomergeError>

where O: AsRef<ExId>, P: Into<Prop>,

Get the value of the given key as at heads, see Self::get()

fn get_all<O, P>( &self, obj: O, prop: P, ) -> Result<Vec<(Value<'_>, ExId)>, AutomergeError>

where O: AsRef<ExId>, P: Into<Prop>,

Get all conflicting values out of the document at this prop that conflict.

fn get_all_at<O, P>( &self, obj: O, prop: P, heads: &[ChangeHash], ) -> Result<Vec<(Value<'_>, ExId)>, AutomergeError>

where O: AsRef<ExId>, P: Into<Prop>,

Get all possibly conflicting values for a key as at heads

fn parents<O>(&self, obj: O) -> Result<Parents<'_>, AutomergeError>

where O: AsRef<ExId>,

Get the parents of an object in the document tree.

fn parents_at<O>( &self, obj: O, heads: &[ChangeHash], ) -> Result<Parents<'_>, AutomergeError>

where O: AsRef<ExId>,

Get the parents of the object obj as at heads

fn get_missing_deps(&self, heads: &[ChangeHash]) -> Vec<ChangeHash>

Get the hashes of the changes in this document that aren’t transitive dependencies of the given heads.

fn get_change_by_hash(&self, hash: &ChangeHash) -> Option<Change>

Get a change by its hash.

fn stats(&self) -> Stats

Return some statistics about the document

fn text_encoding(&self) -> TextEncoding

fn iter(&self) -> DocIter<'_>

Iterate over all the objects in the document

impl Transactable for OwnedTransaction

fn pending_ops(&self) -> usize

Get the number of pending operations in this transaction.

fn put<O, P, V>( &mut self, obj: O, prop: P, value: V, ) -> Result<(), AutomergeError>

where O: AsRef<ExId>, P: Into<Prop>, V: Into<ScalarValue>,

Set the value of property P to value V in object obj.

fn put_object<O, P>( &mut self, obj: O, prop: P, value: ObjType, ) -> Result<ExId, AutomergeError>

where O: AsRef<ExId>, P: Into<Prop>,

Set the value of property P to the new object V in object obj.

fn insert<O, V>( &mut self, obj: O, index: usize, value: V, ) -> Result<(), AutomergeError>

where O: AsRef<ExId>, V: Into<ScalarValue>,

Insert a value into a list at the given index.

fn insert_object<O>( &mut self, obj: O, index: usize, value: ObjType, ) -> Result<ExId, AutomergeError>

where O: AsRef<ExId>,

Insert an object into a list at the given index.

fn increment<O, P>( &mut self, obj: O, prop: P, value: i64, ) -> Result<(), AutomergeError>

where O: AsRef<ExId>, P: Into<Prop>,

Increment the counter at the prop in the object by value.

fn delete<O, P>(&mut self, obj: O, prop: P) -> Result<(), AutomergeError>

where O: AsRef<ExId>, P: Into<Prop>,

Delete the value at prop in the object.

fn splice<O, V, I>( &mut self, obj: O, pos: usize, del: isize, vals: I, ) -> Result<(), AutomergeError>

where O: AsRef<ExId>, V: Into<Value>, I: IntoIterator<Item = V>,

replace a section of a list. If del is positive then N values are deleted after position pos and the new values inserted. If it is negative then N values are deleted before position pos instead.

fn splice_text<O>( &mut self, obj: O, pos: usize, del: isize, text: &str, ) -> Result<(), AutomergeError>

where O: AsRef<ExId>,

Like Self::splice but for text.

fn mark<O>( &mut self, obj: O, mark: Mark, expand: ExpandMark, ) -> Result<(), AutomergeError>

where O: AsRef<ExId>,

Mark a sequence

fn unmark<O>( &mut self, obj: O, name: &str, start: usize, end: usize, expand: ExpandMark, ) -> Result<(), AutomergeError>

where O: AsRef<ExId>,

Remove a Mark from a sequence

fn split_block<O>( &mut self, obj: O, index: usize, ) -> Result<ExId, AutomergeError>

where O: AsRef<ExId>,

Insert a block marker into the text object obj at the given index.

fn join_block<O>(&mut self, text: O, index: usize) -> Result<(), AutomergeError>

where O: AsRef<ExId>,

Delete a block marker at index from the text object obj.

fn replace_block<O>( &mut self, text: O, index: usize, ) -> Result<ExId, AutomergeError>

where O: AsRef<ExId>,

Replace a block marker at index in obj with a new marker and return the ID of the new marker

fn base_heads(&self) -> Vec<ChangeHash>

The heads this transaction will be based on

fn update_text<S>( &mut self, obj: &ExId, new_text: S, ) -> Result<(), AutomergeError>

where S: AsRef<str>,

Update the value of a string

fn update_spans<O, I>( &mut self, text: O, config: UpdateSpansConfig, new_text: I, ) -> Result<(), AutomergeError>

where O: AsRef<ExId>, I: IntoIterator<Item = Span>,

Update the blocks and text in a text object

fn update_object<O>( &mut self, obj: O, new_value: &Value, ) -> Result<(), UpdateObjectError>

where O: AsRef<ExId>,

fn batch_create_object<O, P>( &mut self, obj: O, prop: P, value: &Value, insert: bool, ) -> Result<ExId, AutomergeError>

where O: AsRef<ExId>, P: Into<Prop>,

Put or insert a nested hydrate::Value as a new object tree using batch operations.

fn init_root_from_hydrate(&mut self, value: &Map) -> Result<(), AutomergeError>

Overwrite the keys of the root object with the values from value