Struct DocumentResource 

pub struct DocumentResource { /* private fields */ }

Host-side backing for the document WIT resource (decision A): a point-in-time immutable snapshot. The bindgen with: mapping makes this the resource representation, so the Store’s ResourceTable stores it directly and [HostDocument] methods receive Resource<DocumentResource>.

Implementations

impl DocumentResource

pub fn new(snapshot: Arc<DocumentSnapshot>) -> Self

Wrap a document snapshot as a resource backing.

pub fn get_text_range(&self, range: NativeRange) -> Result<String, String>

The text of the [start, end) byte range. Slices only the requested range out of the rope; the whole document is never materialised. Err on an out-of-range or end < start range (mirrors Buffer::slice).

pub fn line_count(&self) -> u32

Lines the document has, in the sense the WIT contract means: "a\nb\n" is two lines.

CV.3: content space. This surfaced ropey’s raw count, so a guest iterating 0..line-count and calling line(n) got one phantom empty line at the end of every normal file — a rope-implementation detail leaking across the plugin boundary, which every guest author would then have to rediscover and correct for.

pub fn byte_len(&self) -> u64

Total byte length.

pub fn line_at(&self, n: u32) -> Option<String>

Line n (0-based) without its trailing newline (matching Buffer::line), or None past EOF.

pub fn path(&self) -> Option<String>

OM.6b: the file backing this document, absolute; None for a buffer with no path on disk.

A non-UTF-8 path also answers None rather than erroring. The WIT signature has no error channel on purpose — the guest’s question is “can I name a file next to mine”, and “no” is a complete answer to it. Erroring would make one oddly-named file fail an action that has nothing to do with encoding.