Struct ItemPtr

Source

pub struct ItemPtr(/* private fields */);

Expand description

A raw Item pointer. As the underlying block doesn’t move it’s in-memory location, ItemPtr can be considered a pinned object.

Methods from Deref<Target = Item>§

Source

pub fn encode<E>(&self, encoder: &mut E)
where E: Encoder,

Source

pub fn id(&self) -> &ID

Returns a unique identifier of a first update contained by a current Item.

Source

pub fn contains(&self, id: &ID) -> bool

Checks if provided id fits inside of updates defined within bounds of current Item.

Source

pub fn is_deleted(&self) -> bool

Checks if current item is marked as deleted (tombstoned). Yrs uses soft item deletion mechanism, which means that deleted values are not physically erased from memory, but just marked as deleted.

Source

pub fn is_countable(&self) -> bool

Checks if item content can be considered countable. Countable elements can be split and joined together.

Source

pub fn len(&self) -> u32

Returns a length of a block. For most situation it works like Item::content_len with a difference to a Text/[XmlText] contents - in order to achieve compatibility with Yjs we need to calculate string length in terms of UTF-16 character encoding. However depending on used [Encoding] scheme we may calculate string length/offsets differently.

Source

pub fn content_len(&self, kind: OffsetKind) -> u32

Source

pub fn last_id(&self) -> ID

Returns an ID of the last element that can be considered a part of this item.

Struct ItemPtrCopy item path

Methods from Deref<Target = Item>§

pub fn encode<E>(&self, encoder: &mut E)where E: Encoder,

pub fn id(&self) -> &ID

pub fn contains(&self, id: &ID) -> bool

pub fn is_deleted(&self) -> bool

pub fn is_countable(&self) -> bool

pub fn len(&self) -> u32

pub fn content_len(&self, kind: OffsetKind) -> u32

pub fn last_id(&self) -> ID

pub fn info(&self) -> u8

Trait Implementations§

impl Clone for ItemPtr

fn clone(&self) -> ItemPtr

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

impl Debug for ItemPtr

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

impl Deref for ItemPtr

type Target = Item

fn deref(&self) -> &<ItemPtr as Deref>::Target

impl DerefMut for ItemPtr

fn deref_mut(&mut self) -> &mut <ItemPtr as Deref>::Target

impl Display for ItemPtr

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

impl<'a> From<&'a Box<Item>> for ItemPtr

fn from(block: &'a Box<Item>) -> ItemPtr

impl<'a> From<&'a mut Box<Item>> for ItemPtr

fn from(block: &'a mut Box<Item>) -> ItemPtr

impl Hash for ItemPtr

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

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

impl IntoIterator for ItemPtr

type Item = ItemPtr

type IntoIter = BlockIter

fn into_iter(self) -> <ItemPtr as IntoIterator>::IntoIter

impl PartialEq for ItemPtr

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

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

impl TryFrom<ItemPtr> for Any

type Error = ItemPtr

fn try_from(item: ItemPtr) -> Result<Any, <Any as TryFrom<ItemPtr>>::Error>

impl TryFrom<ItemPtr> for ArrayRef

type Error = ItemPtr

fn try_from( value: ItemPtr, ) -> Result<ArrayRef, <ArrayRef as TryFrom<ItemPtr>>::Error>

impl TryFrom<ItemPtr> for Doc

type Error = ItemPtr

fn try_from(item: ItemPtr) -> Result<Doc, <Doc as TryFrom<ItemPtr>>::Error>

impl TryFrom<ItemPtr> for MapRef

type Error = ItemPtr

fn try_from( value: ItemPtr, ) -> Result<MapRef, <MapRef as TryFrom<ItemPtr>>::Error>

impl TryFrom<ItemPtr> for TextRef

type Error = ItemPtr

fn try_from( value: ItemPtr, ) -> Result<TextRef, <TextRef as TryFrom<ItemPtr>>::Error>

impl TryFrom<ItemPtr> for Unused

type Error = ItemPtr

fn try_from(_: ItemPtr) -> Result<Unused, <Unused as TryFrom<ItemPtr>>::Error>

impl TryFrom<ItemPtr> for XmlElementRef

type Error = ItemPtr

fn try_from( value: ItemPtr, ) -> Result<XmlElementRef, <XmlElementRef as TryFrom<ItemPtr>>::Error>

impl TryFrom<ItemPtr> for XmlFragmentRef

type Error = ItemPtr

fn try_from( value: ItemPtr, ) -> Result<XmlFragmentRef, <XmlFragmentRef as TryFrom<ItemPtr>>::Error>

impl TryFrom<ItemPtr> for XmlTextRef

type Error = ItemPtr

fn try_from( value: ItemPtr, ) -> Result<XmlTextRef, <XmlTextRef as TryFrom<ItemPtr>>::Error>

impl Copy for ItemPtr

impl Eq for ItemPtr

Auto Trait Implementations§

impl Freeze for ItemPtr

impl !RefUnwindSafe for ItemPtr

impl !Send for ItemPtr

impl !Sync for ItemPtr

impl Unpin for ItemPtr

impl !UnwindSafe for ItemPtr

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

Struct ItemPtr

pub fn encode<E>(&self, encoder: &mut E)
where E: Encoder,

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

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

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

impl<T> ToOwned for T
where T: Clone,

impl<T> ToString for T
where T: Display + ?Sized,

impl<T> ToStringFallible for T
where T: Display,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

impl<T> ErasedDestructor for T
where T: 'static,