Skip to main content

RawReader

Struct RawReader 

Source
pub struct RawReader<'a, T: SpanWeight<Slab> + HasPos> { /* private fields */ }
Expand description

A low-level reader for sequential byte access across a multi-slab tree.

Unlike column iterators, RawReader reads raw bytes rather than decoded values. It is used internally by Automerge to access byte fields (e.g. actor IDs, string payloads) that are stored as consecutive byte ranges across slab boundaries.

Obtain a RawReader via ColumnData::raw_reader.

Implementations§

Source§

impl<'a, T: SpanWeight<Slab> + HasPos> RawReader<'a, T>

Source

pub fn empty() -> RawReader<'static, T>

Source

pub fn read_next(&mut self, length: usize) -> Result<&'a [u8], ReadRawError>

Read a slice out of a set of slabs

Returns an error if:

  • The read would cross a slab boundary
  • The read would go past the end of the data
Source

pub fn seek_to(&mut self, advance: usize)

Source

pub fn suspend(&self) -> usize

Returns the current byte position, which can be passed to ColumnData::raw_reader to reconstruct a RawReader at the same position.

Trait Implementations§

Source§

impl<'a, T: Clone + SpanWeight<Slab> + HasPos> Clone for RawReader<'a, T>

Source§

fn clone(&self) -> RawReader<'a, T>

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

impl<'a, T: Debug + SpanWeight<Slab> + HasPos> Debug for RawReader<'a, T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, T: Default + SpanWeight<Slab> + HasPos> Default for RawReader<'a, T>

Source§

fn default() -> RawReader<'a, T>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a, T> Freeze for RawReader<'a, T>
where T: Freeze,

§

impl<'a, T> RefUnwindSafe for RawReader<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for RawReader<'a, T>
where T: Send + Sync,

§

impl<'a, T> Sync for RawReader<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for RawReader<'a, T>
where T: Unpin,

§

impl<'a, T> UnsafeUnpin for RawReader<'a, T>
where T: UnsafeUnpin,

§

impl<'a, T> UnwindSafe for RawReader<'a, T>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.