Enum LoroValue

pub enum LoroValue {
    Null,
    Bool(bool),
    Double(f64),
    I64(i64),
    Binary(LoroBinaryValue),
    String(LoroStringValue),
    List(LoroListValue),
    Map(LoroMapValue),
    Container(ContainerID),
}

LoroValue is used to represents the state of CRDT at a given version.

This struct is cheap to clone, the time complexity is O(1).

Variants

Null

Bool(bool)

Double(f64)

I64(i64)

Binary(LoroBinaryValue)

String(LoroStringValue)

List(LoroListValue)

Map(LoroMapValue)

Container(ContainerID)

Implementations

impl LoroValue

pub fn is_null(&self) -> bool

Returns true if this is a LoroValue::Null, otherwise false

pub fn is_bool(&self) -> bool

Returns true if this is a LoroValue::Bool, otherwise false

pub fn as_bool_mut(&mut self) -> Option<&mut bool>

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

pub fn as_bool(&self) -> Option<&bool>

Optionally returns references to the inner fields if this is a LoroValue::Bool, otherwise None

pub fn into_bool(self) -> Result<bool, LoroValue>

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

pub fn is_double(&self) -> bool

Returns true if this is a LoroValue::Double, otherwise false

pub fn as_double_mut(&mut self) -> Option<&mut f64>

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

pub fn as_double(&self) -> Option<&f64>

Optionally returns references to the inner fields if this is a LoroValue::Double, otherwise None

pub fn into_double(self) -> Result<f64, LoroValue>

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

pub fn is_i64(&self) -> bool

Returns true if this is a LoroValue::I64, otherwise false

pub fn as_i64_mut(&mut self) -> Option<&mut i64>

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

pub fn as_i64(&self) -> Option<&i64>

Optionally returns references to the inner fields if this is a LoroValue::I64, otherwise None

pub fn into_i64(self) -> Result<i64, LoroValue>

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

pub fn is_binary(&self) -> bool

Returns true if this is a LoroValue::Binary, otherwise false

pub fn as_binary_mut(&mut self) -> Option<&mut LoroBinaryValue>

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

pub fn as_binary(&self) -> Option<&LoroBinaryValue>

Optionally returns references to the inner fields if this is a LoroValue::Binary, otherwise None

pub fn into_binary(self) -> Result<LoroBinaryValue, LoroValue>

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

pub fn is_string(&self) -> bool

Returns true if this is a LoroValue::String, otherwise false

pub fn as_string_mut(&mut self) -> Option<&mut LoroStringValue>

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

pub fn as_string(&self) -> Option<&LoroStringValue>

Optionally returns references to the inner fields if this is a LoroValue::String, otherwise None

pub fn into_string(self) -> Result<LoroStringValue, LoroValue>

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

pub fn is_list(&self) -> bool

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

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

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

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

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

pub fn into_list(self) -> Result<LoroListValue, LoroValue>

Returns the inner fields if this is a LoroValue::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 LoroValue::Map, otherwise false

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

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

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

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

pub fn into_map(self) -> Result<LoroMapValue, LoroValue>

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

pub fn is_container(&self) -> bool

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

pub fn as_container_mut(&mut self) -> Option<&mut ContainerID>

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

pub fn as_container(&self) -> Option<&ContainerID>

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

pub fn into_container(self) -> Result<ContainerID, LoroValue>

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

impl LoroValue

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

pub fn get_by_index(&self, index: isize) -> Option<&LoroValue>

pub fn is_false(&self) -> bool

pub fn get_depth(&self) -> usize

pub fn is_too_deep(&self) -> bool

pub fn visit_children(&self, f: &mut dyn FnMut(&LoroValue))

Visit the all list items or map’s values

pub fn is_empty_collection(&self) -> bool

Trait Implementations

impl ApplyDiff for LoroValue

fn apply_diff_shallow(&mut self, diff: &[Diff])

fn apply_diff(&mut self, diff: &[Diff])

fn apply(&mut self, path: &Path, diff: &[Diff])

impl<'a> Arbitrary<'a> for LoroValue

fn arbitrary(u: &mut Unstructured<'a>) -> Result<LoroValue, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for LoroValue

fn clone(&self) -> LoroValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LoroValue

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

Formats the value using the given formatter.

impl Default for LoroValue

fn default() -> LoroValue

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LoroValue

fn deserialize<D>( deserializer: D, ) -> Result<LoroValue, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EstimatedSize for LoroValue

fn estimate_storage_size(&self) -> usize

Estimate the storage size of the object in bytes

impl<'a> From<&'a [LoroValue]> for LoroValue

fn from(v: &'a [LoroValue]) -> LoroValue

Converts to this type from the input type.

impl From<&[u8]> for LoroValue

fn from(vec: &[u8]) -> LoroValue

Converts to this type from the input type.

impl<const N: usize> From<&[u8; N]> for LoroValue

fn from(vec: &[u8; N]) -> LoroValue

Converts to this type from the input type.

impl From<&str> for LoroValue

fn from(v: &str) -> LoroValue

Converts to this type from the input type.

impl From<ContainerID> for LoroValue

fn from(v: ContainerID) -> LoroValue

Converts to this type from the input type.

impl<S, M> From<HashMap<S, LoroValue, M>> for LoroValue

where S: Into<String>,

fn from(map: HashMap<S, LoroValue, M>) -> LoroValue

Converts to this type from the input type.

impl From<LoroValue> for ValueOrHandler

fn from(value: LoroValue) -> Self

Converts to this type from the input type.

impl From<String> for LoroValue

fn from(v: String) -> LoroValue

Converts to this type from the input type.

impl<T> From<Vec<T>> for LoroValue

where T: Into<LoroValue>,

fn from(value: Vec<T>) -> LoroValue

Converts to this type from the input type.

impl From<Vec<u8>> for LoroValue

fn from(vec: Vec<u8>) -> LoroValue

Converts to this type from the input type.

impl From<bool> for LoroValue

fn from(v: bool) -> LoroValue

Converts to this type from the input type.

impl From<f64> for LoroValue

fn from(v: f64) -> LoroValue

Converts to this type from the input type.

impl From<i16> for LoroValue

fn from(v: i16) -> LoroValue

Converts to this type from the input type.

impl From<i32> for LoroValue

fn from(v: i32) -> LoroValue

Converts to this type from the input type.

impl From<i64> for LoroValue

fn from(v: i64) -> LoroValue

Converts to this type from the input type.

impl From<u16> for LoroValue

fn from(v: u16) -> LoroValue

Converts to this type from the input type.

impl From<u32> for LoroValue

fn from(v: u32) -> LoroValue

Converts to this type from the input type.

impl FromIterator<LoroValue> for LoroListValue

fn from_iter<T>(iter: T) -> LoroListValue

where T: IntoIterator<Item = LoroValue>,

Creates a value from an iterator.

impl Hash for LoroValue

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<&str> for LoroValue

type Output = LoroValue

The returned type after indexing.

fn index(&self, index: &str) -> &<LoroValue as Index<&str>>::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for LoroValue

type Output = LoroValue

The returned type after indexing.

fn index(&self, index: usize) -> &<LoroValue as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl PartialEq for LoroValue

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LoroValue

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl ToJson for LoroValue

fn to_json_value(&self) -> Value

fn to_json(&self) -> String

fn to_json_pretty(&self) -> String

fn from_json(s: &str) -> Self

impl TryFrom<LoroValue> for Arc<HashMap<String, LoroValue, BuildHasherDefault<FxHasher>>>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from( value: LoroValue, ) -> Result<Arc<HashMap<String, LoroValue, BuildHasherDefault<FxHasher>>>, <Arc<HashMap<String, LoroValue, BuildHasherDefault<FxHasher>>> as TryFrom<LoroValue>>::Error>

Performs the conversion.

impl TryFrom<LoroValue> for Arc<String>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from( value: LoroValue, ) -> Result<Arc<String>, <Arc<String> as TryFrom<LoroValue>>::Error>

Performs the conversion.

impl TryFrom<LoroValue> for Arc<Vec<LoroValue>>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from( value: LoroValue, ) -> Result<Arc<Vec<LoroValue>>, <Arc<Vec<LoroValue>> as TryFrom<LoroValue>>::Error>

Performs the conversion.

impl TryFrom<LoroValue> for Arc<Vec<u8>>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from( value: LoroValue, ) -> Result<Arc<Vec<u8>>, <Arc<Vec<u8>> as TryFrom<LoroValue>>::Error>

Performs the conversion.

impl TryFrom<LoroValue> for ContainerID

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from( value: LoroValue, ) -> Result<ContainerID, <ContainerID as TryFrom<LoroValue>>::Error>

Performs the conversion.

impl Eq for LoroValue

impl StructuralPartialEq for LoroValue