ItemPtr

eidetica::y_crdt::block

Struct ItemPtr

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>§

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

pub fn id(&self) -> &ID

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

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

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

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.

pub fn is_countable(&self) -> bool

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

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.

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

pub fn last_id(&self) -> ID

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

pub fn info(&self) -> u8

Trait Implementations§

impl Clone for ItemPtr

fn clone(&self) -> ItemPtr

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for ItemPtr

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

Formats the value using the given formatter. Read more

impl Deref for ItemPtr

type Target = Item

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for ItemPtr

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

Mutably dereferences the value.

impl Display for ItemPtr

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

Formats the value using the given formatter. Read more

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl Hash for ItemPtr

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

impl IntoIterator for ItemPtr

type Item = ItemPtr

The type of the elements being iterated over.

type IntoIter = BlockIter

Which kind of iterator are we turning this into?

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

Creates an iterator from a value. Read more

impl PartialEq for ItemPtr

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

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

1.0.0 · Source§

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 TryFrom<ItemPtr> for Any

type Error = ItemPtr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ItemPtr> for ArrayRef

type Error = ItemPtr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ItemPtr> for BranchPtr

type Error = ItemPtr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ItemPtr> for Doc

type Error = ItemPtr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ItemPtr> for MapRef

type Error = ItemPtr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ItemPtr> for Out

type Error = ItemPtr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ItemPtr> for TextRef

type Error = ItemPtr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ItemPtr> for Unused

type Error = ItemPtr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ItemPtr> for XmlElementRef

type Error = ItemPtr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ItemPtr> for XmlFragmentRef

type Error = ItemPtr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ItemPtr> for XmlOut

type Error = ItemPtr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ItemPtr> for XmlTextRef

type Error = ItemPtr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for ItemPtr

impl Eq for ItemPtr

impl Send for ItemPtr

impl Sync for ItemPtr

Auto Trait Implementations§

impl Freeze for ItemPtr

impl !RefUnwindSafe for ItemPtr

impl Unpin for ItemPtr

impl !UnwindSafe for ItemPtr

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> CompatExt for T

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more

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

fn __clone_box(&self, _: Private) -> *mut ()

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

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

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

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

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

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> IterExt for T
where T: IntoIterator,

fn merge(self) -> MergeBounded<Self::Item>
where Self: Sized, Self::Item: Stream,

Combines an iterator of streams into a single stream, yielding items as they arrive. Read more

fn merge_unbounded(self) -> MergeUnbounded<Self::Item>
where Self: Sized, Self::Item: Stream + Unpin,

Combines an iterator of streams into a single stream, yielding items as they arrive. Read more

fn join_all(self) -> JoinAll<Self::Item>
where Self: Sized, Self::Item: Future,

Waits for all futures to complete, returning a Vec of their outputs. Read more

fn try_join_all(self) -> TryJoinAll<Self::Item>
where Self: Sized, Self::Item: TryFuture,

Waits for all futures to complete, returning a Result<Vec<T>, E>. Read more

fn into_unordered_stream(self) -> FuturesUnorderedBounded<Self::Item>
where Self: Sized, Self::Item: Future,

Combines an iterator of futures into a concurrent stream, yielding items as they arrive. Read more

fn into_unordered_stream_unbounded(self) -> FuturesUnordered<Self::Item>
where Self: Sized, Self::Item: Future,

Combines an iterator of futures into a concurrent stream, yielding items as they arrive. Read more

fn into_ordered_stream(self) -> FuturesOrderedBounded<Self::Item>
where Self: Sized, Self::Item: Future,

Combines an iterator of futures into a concurrent stream, yielding items in their original order. Read more

fn into_ordered_stream_unbounded(self) -> FuturesOrdered<Self::Item>
where Self: Sized, Self::Item: Future,

Combines an iterator of futures into a concurrent stream, yielding items in their original order. Read more

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

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

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

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

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more