Struct yrs::types::text::TextPrelim

pub struct TextPrelim<T: Borrow<str>>(/* private fields */);

A preliminary text. It’s can be used to initialize a TextRef, when it’s about to be nested into another Yrs data collection, such as Map or Array.

Implementations

impl<T: Borrow<str>> TextPrelim<T>

pub fn new(value: T) -> Self

Trait Implementations

impl<T: Debug + Borrow<str>> Debug for TextPrelim<T>

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

Formats the value using the given formatter.

impl<T: Borrow<str>> Into<EmbedPrelim<TextPrelim<T>>> for TextPrelim<T>

fn into(self) -> EmbedPrelim<TextPrelim<T>>

Converts this type into the (usually inferred) input type.

impl<T: Borrow<str>> Prelim for TextPrelim<T>

type Return = TextRef

Type of a value to be returned as a result of inserting this Prelim type instance. Use Unused if none is necessary.

fn into_content( self, _txn: &mut TransactionMut<'_> ) -> (ItemContent, Option<Self>)

This method is used to create initial content required in order to create a block item. A supplied ptr can be used to identify block that is about to be created to store the returned content.

fn integrate(self, txn: &mut TransactionMut<'_>, inner_ref: BranchPtr)

Method called once an original item filled with content from Self::into_content has been added to block store. This method is used by complex types such as maps or arrays to append the original contents of prelim struct into YMap, YArray etc.