Struct MapHandler

pub struct MapHandler { /* private fields */ }

Implementations

impl MapHandler

pub fn new_detached() -> Self

Create a new container that is detached from the document. The edits on a detached container will not be persisted. To attach the container to the document, please insert it into an attached container.

pub fn insert(&self, key: &str, value: impl Into<LoroValue>) -> LoroResult<()>

pub fn insert_with_txn( &self, txn: &mut Transaction, key: &str, value: LoroValue, ) -> LoroResult<()>

pub fn insert_container<T: HandlerTrait>( &self, key: &str, handler: T, ) -> LoroResult<T>

pub fn insert_container_with_txn<H: HandlerTrait>( &self, txn: &mut Transaction, key: &str, child: H, ) -> LoroResult<H>

pub fn delete(&self, key: &str) -> LoroResult<()>

pub fn delete_with_txn( &self, txn: &mut Transaction, key: &str, ) -> LoroResult<()>

pub fn for_each<I>(&self, f: I)

where I: FnMut(&str, ValueOrHandler),

pub fn get_child_handler(&self, key: &str) -> LoroResult<Handler>

pub fn get_deep_value_with_id(&self) -> LoroResult<LoroValue>

pub fn get(&self, key: &str) -> Option<LoroValue>

pub fn get_(&self, key: &str) -> Option<ValueOrHandler>

Get the value at given key, if value is a container, return a handler to the container

pub fn get_or_create_container<C: HandlerTrait>( &self, key: &str, child: C, ) -> LoroResult<C>

pub fn contains_key(&self, key: &str) -> bool

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn is_deleted(&self) -> bool

pub fn clear(&self) -> LoroResult<()>

pub fn clear_with_txn(&self, txn: &mut Transaction) -> LoroResult<()>

pub fn keys(&self) -> impl Iterator<Item = InternalString> + '_

pub fn values(&self) -> impl Iterator<Item = ValueOrHandler> + '_

pub fn get_last_editor(&self, key: &str) -> Option<PeerID>

Trait Implementations

impl Clone for MapHandler

fn clone(&self) -> MapHandler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MapHandler

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

Formats the value using the given formatter.

impl HandlerTrait for MapHandler

fn is_attached(&self) -> bool

fn attached_handler(&self) -> Option<&BasicHandler>

fn get_value(&self) -> LoroValue

fn get_deep_value(&self) -> LoroValue

fn kind(&self) -> ContainerType

fn to_handler(&self) -> Handler

fn attach( &self, txn: &mut Transaction, parent: &BasicHandler, self_id: ContainerID, ) -> LoroResult<Self>

This method returns an attached handler.

fn get_attached(&self) -> Option<Self>

If a detached container is attached, this method will return its corresponding attached handler.

fn from_handler(h: Handler) -> Option<Self>

fn doc(&self) -> Option<LoroDoc>

fn parent(&self) -> Option<Handler>

fn idx(&self) -> ContainerIdx

fn id(&self) -> ContainerID

fn with_state<R>( &self, f: impl FnOnce(&mut State) -> LoroResult<R>, ) -> LoroResult<R>