Enum Out 

pub enum Out {
    Any(Any),
    YText(TextRef),
    YArray(ArrayRef),
    YMap(MapRef),
    YXmlElement(XmlElementRef),
    YXmlFragment(XmlFragmentRef),
    YXmlText(XmlTextRef),
    YDoc(Doc),
    UndefinedRef(BranchPtr),
}

Value that can be returned by Yrs data types. This includes Any which is an extension representation of JSON, but also nested complex collaborative structures specific to Yrs.

Variants

Any(Any)

Any value that it treated as a single element in its entirety.

YText(TextRef)

Instance of a TextRef.

YArray(ArrayRef)

Instance of an ArrayRef.

YMap(MapRef)

Instance of a MapRef.

YXmlElement(XmlElementRef)

Instance of a XmlElementRef.

YXmlFragment(XmlFragmentRef)

Instance of a XmlFragmentRef.

YXmlText(XmlTextRef)

Instance of a XmlTextRef.

YDoc(Doc)

Subdocument.

UndefinedRef(BranchPtr)

Instance of a shared collection of undefined type. Usually happens when it refers to a root type that has not been defined locally. Can also refer to a [WeakRef] if “weak” feature flag was not set.

Implementations

impl Out

pub fn cast<T>(self) -> Result<T, Self>

where T: TryFrom<Self, Error = Self>,

Attempts to convert current Out value directly onto a different type, as along as it implements TryFrom trait. If conversion is not possible, the original value is returned.

pub fn to_string<T: ReadTxn>(self, txn: &T) -> String

Converts current value into stringified representation.

pub fn try_branch(&self) -> Option<&Branch>

Trait Implementations

impl AsPrelim for Out

type Prelim = In

fn as_prelim<T: ReadTxn>(&self, txn: &T) -> Self::Prelim

Converts current type contents into a Prelim type that can be used to create a new type that’s a deep copy equivalent of a current type.

impl Clone for Out

fn clone(&self) -> Out

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Out

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

Formats the value using the given formatter.

impl Default for Out

fn default() -> Self

Returns the “default value” for a type.

impl Display for Out

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

Formats the value using the given formatter.

impl<T> From<T> for Out

where T: Into<Any>,

fn from(v: T) -> Self

Converts to this type from the input type.

impl From<XmlOut> for Out

fn from(value: XmlOut) -> Self

Converts to this type from the input type.

impl Into<Out> for BranchPtr

fn into(self) -> Out

Converts current branch data into a Out. It uses a type ref information to resolve, which value variant is a correct one for this branch. Since branch represent only complex types Out::Any will never be returned from this method.

impl PartialEq for Out

fn eq(&self, other: &Out) -> 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 ToJson for Out

fn to_json<T: ReadTxn>(&self, txn: &T) -> Any

Converts current value into Any object equivalent that resembles enhanced JSON payload. Rules are:

• Primitive types (Out::Any) are passed right away, as no transformation is needed.
• Out::YArray is converted into JSON-like array.
• Out::YMap is converted into JSON-like object map.
• Out::YText, Out::YXmlText and Out::YXmlElement are converted into strings (XML types are stringified XML representation).

impl TryFrom<ItemPtr> for Out

type Error = ItemPtr

The type returned in the event of a conversion error.

fn try_from(value: ItemPtr) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for Arc<[u8]>

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for Arc<str>

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for ArrayRef

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for Doc

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for MapRef

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for String

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for TextRef

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for Vec<u8>

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for XmlElementRef

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for XmlFragmentRef

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for XmlOut

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for XmlTextRef

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for bool

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for f32

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for f64

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for i16

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for i32

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for i64

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for isize

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for u16

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Out> for u32

type Error = Out

The type returned in the event of a conversion error.

fn try_from(value: Out) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Out