Enum Container

pub enum Container {
    List(LoroList),
    Map(LoroMap),
    Text(LoroText),
    Tree(LoroTree),
    MovableList(LoroMovableList),
    Unknown(LoroUnknown),
}

All the CRDT containers supported by Loro.

Variants

List(LoroList)

LoroList container

Map(LoroMap)

LoroMap container

Text(LoroText)

LoroText container

Tree(LoroTree)

[LoroTree container]

MovableList(LoroMovableList)

LoroMovableList container

Unknown(LoroUnknown)

Unknown container

Implementations

impl Container

pub fn is_list(&self) -> bool

Returns true if this is a Container::List, otherwise false

pub fn as_list_mut(&mut self) -> Option<&mut LoroList>

Optionally returns mutable references to the inner fields if this is a Container::List, otherwise None

pub fn as_list(&self) -> Option<&LoroList>

Optionally returns references to the inner fields if this is a Container::List, otherwise None

pub fn into_list(self) -> Result<LoroList, Self>

Returns the inner fields if this is a Container::List, otherwise returns back the enum in the Err case of the result

pub fn is_map(&self) -> bool

Returns true if this is a Container::Map, otherwise false

pub fn as_map_mut(&mut self) -> Option<&mut LoroMap>

Optionally returns mutable references to the inner fields if this is a Container::Map, otherwise None

pub fn as_map(&self) -> Option<&LoroMap>

Optionally returns references to the inner fields if this is a Container::Map, otherwise None

pub fn into_map(self) -> Result<LoroMap, Self>

Returns the inner fields if this is a Container::Map, otherwise returns back the enum in the Err case of the result

pub fn is_text(&self) -> bool

Returns true if this is a Container::Text, otherwise false

pub fn as_text_mut(&mut self) -> Option<&mut LoroText>

Optionally returns mutable references to the inner fields if this is a Container::Text, otherwise None

pub fn as_text(&self) -> Option<&LoroText>

Optionally returns references to the inner fields if this is a Container::Text, otherwise None

pub fn into_text(self) -> Result<LoroText, Self>

Returns the inner fields if this is a Container::Text, otherwise returns back the enum in the Err case of the result

pub fn is_tree(&self) -> bool

Returns true if this is a Container::Tree, otherwise false

pub fn as_tree_mut(&mut self) -> Option<&mut LoroTree>

Optionally returns mutable references to the inner fields if this is a Container::Tree, otherwise None

pub fn as_tree(&self) -> Option<&LoroTree>

Optionally returns references to the inner fields if this is a Container::Tree, otherwise None

pub fn into_tree(self) -> Result<LoroTree, Self>

Returns the inner fields if this is a Container::Tree, otherwise returns back the enum in the Err case of the result

pub fn is_movable_list(&self) -> bool

Returns true if this is a Container::MovableList, otherwise false

pub fn as_movable_list_mut(&mut self) -> Option<&mut LoroMovableList>

Optionally returns mutable references to the inner fields if this is a Container::MovableList, otherwise None

pub fn as_movable_list(&self) -> Option<&LoroMovableList>

Optionally returns references to the inner fields if this is a Container::MovableList, otherwise None

pub fn into_movable_list(self) -> Result<LoroMovableList, Self>

Returns the inner fields if this is a Container::MovableList, otherwise returns back the enum in the Err case of the result

pub fn is_unknown(&self) -> bool

Returns true if this is a Container::Unknown, otherwise false

pub fn as_unknown_mut(&mut self) -> Option<&mut LoroUnknown>

Optionally returns mutable references to the inner fields if this is a Container::Unknown, otherwise None

pub fn as_unknown(&self) -> Option<&LoroUnknown>

Optionally returns references to the inner fields if this is a Container::Unknown, otherwise None

pub fn into_unknown(self) -> Result<LoroUnknown, Self>

Returns the inner fields if this is a Container::Unknown, otherwise returns back the enum in the Err case of the result

impl Container

pub fn new(kind: ContainerType) -> Self

Create a detached container of the given type.

A detached container is a container that is not attached to a 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 get_type(&self) -> ContainerType

Get the type of the container.

Trait Implementations

impl Clone for Container

fn clone(&self) -> Container

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ContainerTrait for Container

type Handler = Handler

The handler of the container.

fn id(&self) -> ContainerID

Get the ID of the container.

fn to_container(&self) -> Container

Convert the container to a Container.

fn to_handler(&self) -> Self::Handler

Convert the container to a handler.

fn from_handler(handler: Self::Handler) -> Self

Convert the handler to a container.

fn is_attached(&self) -> bool

Whether the container is attached to a document.

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

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

fn try_from_container(container: Container) -> Option<Self>

where Self: Sized,

Try to convert the container to the handler.

fn is_deleted(&self) -> bool

Whether the container is deleted.

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

Get the doc of the container.

fn subscribe(&self, callback: Subscriber) -> Option<Subscription>

Subscribe to the container.

impl Debug for Container

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

Formats the value using the given formatter.

impl From<Handler> for Container

fn from(value: InnerHandler) -> Self

Converts to this type from the input type.