Struct yrs::types::array::Array

#[repr(transparent)]
pub struct Array(_);

A collection used to store data in an indexed sequence structure. This type is internally implemented as a double linked list, which may squash values inserted directly one after another into single list node upon transaction commit.

Reading a root-level type as an YArray means treating its sequence components as a list, where every countable element becomes an individual entity:

• JSON-like primitives (booleans, numbers, strings, JSON maps, arrays etc.) are counted individually.
• Text chunks inserted by [Text] data structure: each character becomes an element of an array.
• Embedded and binary values: they count as a single element even though they correspond of multiple bytes.

Like all Yrs shared data types, YArray is resistant to the problem of interleaving (situation when elements inserted one after another may interleave with other peers concurrent inserts after merging all updates together). In case of Yrs conflict resolution is solved by using unique document id to determine correct and consistent ordering.

Implementations

impl Array

pub fn len(&self) -> u32

Returns a number of elements stored in current array.

pub fn insert<V: Prelim>(&self, txn: &mut Transaction, index: u32, value: V)

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.

Using index value that’s higher than current array length results in panic.

pub fn insert_range<T, V>(&self, txn: &mut Transaction, index: u32, values: T) where
    T: IntoIterator<Item = V>,
    V: Into<Any>, 

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.

Using index value that’s higher than current array length results in panic.

pub fn push_back<V: Prelim>(&self, txn: &mut Transaction, value: V)

Inserts given value at the end of the current array.

pub fn push_front<V: Prelim>(&self, txn: &mut Transaction, content: V)

Inserts given value at the beginning of the current array.

pub fn remove(&self, txn: &mut Transaction, index: u32)

Removes a single element at provided index.

pub fn remove_range(&self, txn: &mut Transaction, 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.

pub fn get(&self, 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.

pub fn iter(&self) -> ArrayIter<'_>

Returns an iterator, that can be used to lazely traverse over all values stored in a current array.

pub fn to_json(&self) -> Any

Converts all contents of current array into a JSON-like representation.

pub fn observe<F>(&mut self, f: F) -> Subscription<ArrayEvent> where
    F: Fn(&Transaction, &ArrayEvent) + 'static, 

Subscribes a given callback to be triggered whenever current array is changed. A callback is triggered whenever a transaction gets committed. This function does not trigger if changes have been observed by nested shared collections.

All array changes can be tracked by using [Event::delta] method.

Returns an [Observer] which, when dropped, will unsubscribe current callback.

pub fn unobserve(&mut self, subscription_id: SubscriptionId)

Unsubscribes a previously subscribed event callback identified by given subscription_id.

Trait Implementations

impl AsMut<Branch> for Array

fn as_mut(&mut self) -> &mut Branch

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Branch> for Array

fn as_ref(&self) -> &Branch

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Array

fn clone(&self) -> Array

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Array

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

Formats the value using the given formatter.

impl From<BranchPtr> for Array

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl PartialEq<Array> for Array

fn eq(&self, other: &Array) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Array

impl StructuralEq for Array

impl StructuralPartialEq for Array