pub trait Array: AsRef<Branch> + Sized {
// Provided methods
fn len<T: ReadTxn>(&self, _txn: &T) -> u32 { ... }
fn insert<V>(
&self,
txn: &mut TransactionMut<'_>,
index: u32,
value: V
) -> V::Return
where V: Prelim { ... }
fn insert_range<T, V>(
&self,
txn: &mut TransactionMut<'_>,
index: u32,
values: T
)
where T: IntoIterator<Item = V>,
V: Into<Any> { ... }
fn push_back<V>(&self, txn: &mut TransactionMut<'_>, value: V) -> V::Return
where V: Prelim { ... }
fn push_front<V>(
&self,
txn: &mut TransactionMut<'_>,
content: V
) -> V::Return
where V: Prelim { ... }
fn remove(&self, txn: &mut TransactionMut<'_>, index: u32) { ... }
fn remove_range(&self, txn: &mut TransactionMut<'_>, index: u32, len: u32) { ... }
fn get<T: ReadTxn>(&self, txn: &T, index: u32) -> Option<Value> { ... }
fn move_to(&self, txn: &mut TransactionMut<'_>, source: u32, target: u32) { ... }
fn move_range_to(
&self,
txn: &mut TransactionMut<'_>,
start: u32,
assoc_start: Assoc,
end: u32,
assoc_end: Assoc,
target: u32
) { ... }
fn iter<'a, T: ReadTxn + 'a>(&self, txn: &'a T) -> ArrayIter<&'a T, T> ⓘ { ... }
}
Provided Methods§
sourcefn len<T: ReadTxn>(&self, _txn: &T) -> u32
fn len<T: ReadTxn>(&self, _txn: &T) -> u32
Returns a number of elements stored in current array.
sourcefn insert<V>(
&self,
txn: &mut TransactionMut<'_>,
index: u32,
value: V
) -> V::Returnwhere
V: Prelim,
fn insert<V>(
&self,
txn: &mut TransactionMut<'_>,
index: u32,
value: V
) -> V::Returnwhere
V: Prelim,
Inserts a value
at the given index
. Inserting at index 0
is equivalent to prepending
current array with given value
, while inserting at array length is equivalent to appending
that value at the end of it.
Returns a reference to an integrated preliminary input.
§Panics
This method will panic if provided index
is greater than the current length of an ArrayRef.
sourcefn insert_range<T, V>(
&self,
txn: &mut TransactionMut<'_>,
index: u32,
values: T
)
fn insert_range<T, V>( &self, txn: &mut TransactionMut<'_>, index: u32, values: T )
Inserts multiple values
at the given index
. Inserting at index 0
is equivalent to
prepending current array with given values
, while inserting at array length is equivalent
to appending that value at the end of it.
§Panics
This method will panic if provided index
is greater than the current length of an ArrayRef.
sourcefn push_back<V>(&self, txn: &mut TransactionMut<'_>, value: V) -> V::Returnwhere
V: Prelim,
fn push_back<V>(&self, txn: &mut TransactionMut<'_>, value: V) -> V::Returnwhere
V: Prelim,
Inserts given value
at the end of the current array.
Returns a reference to an integrated preliminary input.
sourcefn push_front<V>(&self, txn: &mut TransactionMut<'_>, content: V) -> V::Returnwhere
V: Prelim,
fn push_front<V>(&self, txn: &mut TransactionMut<'_>, content: V) -> V::Returnwhere
V: Prelim,
Inserts given value
at the beginning of the current array.
Returns a reference to an integrated preliminary input.
sourcefn remove(&self, txn: &mut TransactionMut<'_>, index: u32)
fn remove(&self, txn: &mut TransactionMut<'_>, index: u32)
Removes a single element at provided index
.
sourcefn remove_range(&self, txn: &mut TransactionMut<'_>, index: u32, len: u32)
fn remove_range(&self, txn: &mut TransactionMut<'_>, index: u32, len: u32)
Removes a range of elements from current array, starting at given index
up until
a particular number described by len
has been deleted. This method panics in case when
not all expected elements were removed (due to insufficient number of elements in an array)
or index
is outside of the bounds of an array.
sourcefn get<T: ReadTxn>(&self, txn: &T, index: u32) -> Option<Value>
fn get<T: ReadTxn>(&self, txn: &T, index: u32) -> Option<Value>
Retrieves a value stored at a given index
. Returns None
when provided index was out
of the range of a current array.
sourcefn move_to(&self, txn: &mut TransactionMut<'_>, source: u32, target: u32)
fn move_to(&self, txn: &mut TransactionMut<'_>, source: u32, target: u32)
Moves element found at source
index into target
index position. Both indexes refer to a
current state of the document.
§Panics
This method panics if either source
or target
indexes are greater than current array’s
length.
sourcefn move_range_to(
&self,
txn: &mut TransactionMut<'_>,
start: u32,
assoc_start: Assoc,
end: u32,
assoc_end: Assoc,
target: u32
)
fn move_range_to( &self, txn: &mut TransactionMut<'_>, start: u32, assoc_start: Assoc, end: u32, assoc_end: Assoc, target: u32 )
Moves all elements found within start
..end
indexes range (both side inclusive) into
new position pointed by target
index. All elements inserted concurrently by other peers
inside of moved range will be moved as well after synchronization (although it make take
more than one sync roundtrip to achieve convergence).
assoc_start
/assoc_end
flags are used to mark if ranges should include elements that
might have been inserted concurrently at the edges of the range definition.
Example:
use yrs::{Doc, Transact, Array, Assoc};
let doc = Doc::new();
let array = doc.get_or_insert_array("array");
array.insert_range(&mut doc.transact_mut(), 0, [1,2,3,4]);
// move elements 2 and 3 after the 4
array.move_range_to(&mut doc.transact_mut(), 1, Assoc::After, 2, Assoc::Before, 4);
let values: Vec<_> = array.iter(&doc.transact()).collect();
assert_eq!(values, vec![1.into(), 4.into(), 2.into(), 3.into()]);
§Panics
This method panics if either start
, end
or target
indexes are greater than current
array’s length.