Skip to main content

Snapshot

Struct Snapshot 

Source
pub struct Snapshot { /* private fields */ }
Expand description

An immutable, Send + Sync copy of the document for background consumers (e.g. a debounced compile thread).

Creation is O(1) — a rope clone shares structure. The consumer pays for what it reads: Snapshot::text is an O(len) materialization that now runs on the consumer’s thread, not the UI thread; the ranged reads mirror Buffer’s backing-agnostic API.

Implementations§

Source§

impl Snapshot

Source

pub fn len(&self) -> u32

Total byte length of the snapshot.

Source

pub fn is_empty(&self) -> bool

Whether the snapshot is empty (a single empty line — never truly zero).

Source

pub fn text(&self) -> Cow<'_, str>

The whole snapshot text, LF-only. Borrowed for single-chunk (small) documents; an O(len) materialization otherwise — run it on the consumer’s thread.

Source

pub fn slice(&self, range: Range<u32>) -> Cow<'_, str>

The text in range (byte offsets on char boundaries). Clamps to the snapshot end.

Source

pub fn line(&self, row: u32) -> Cow<'_, str>

The text of one row, excluding its trailing \n. Out-of-range rows return "".

Source

pub fn line_count(&self) -> u32

Number of lines. Always ≥ 1; a trailing \n yields a final empty line.

Source

pub fn doc_id(&self) -> DocId

The document this snapshot came from.

Source

pub fn revision(&self) -> Revision

The revision this snapshot froze.

Trait Implementations§

Source§

impl Clone for Snapshot

Source§

fn clone(&self) -> Snapshot

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Snapshot

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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.