Skip to main content

WasmDocument

Struct WasmDocument 

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

A YAML document with byte-faithful source preservation and path-targeted edits.

Implementations§

Source§

impl WasmDocument

Source

pub fn new(yaml: &str) -> Result<WasmDocument, JsError>

Parse a YAML string into a lossless Document.

Source

pub fn to_string(&self) -> String

Re-emit the document as a string. Byte-identical to original if no edits.

Bound on the JS side as toString() (the conventional camelCase name) so callers can write doc.toString() and override the default Object.prototype.toString rather than coexist with it.

Source

pub fn replace_span( &mut self, start: usize, end: usize, replacement: &str, ) -> Result<(), JsError>

Replace the bytes at start..end with replacement.

Bound on the JS side as replaceSpan(start, end, replacement) per JS naming conventions.

Source

pub fn get(&self, path: &str) -> Result<JsValue, JsError>

Get the parsed value at a dotted path.

Source

pub fn get_source(&self, path: &str) -> JsValue

Get the raw source fragment at a dotted path.

Bound on the JS side as getSource(path) per JS naming conventions.

Source

pub fn span_at(&self, path: &str) -> Result<JsValue, JsError>

Get the byte range { start, end } for the value at a dotted path.

Bound on the JS side as spanAt(path) per JS naming conventions.

Source

pub fn set_value(&mut self, path: &str, value: JsValue) -> Result<(), JsError>

Set a value at a dotted path using a JS object.

Bound on the JS side as setValue(path, value) per JS naming conventions.

Source

pub fn set(&mut self, path: &str, fragment: &str) -> Result<(), JsError>

Set a value at a dotted path using a YAML fragment string.

Source

pub fn comments_at(&self, path: &str) -> Result<JsValue, JsError>

Read the YAML comments associated with the node at path. Returns { before: string[], inline: string | null } so the caller can surface human-authored doc-comments alongside values — the demo that motivates the entire CST architecture.

Bound on the JS side as commentsAt(path) per JS naming conventions.

Source§

impl WasmDocument

Source

pub fn as_document(&self) -> &Document

Native (rlib) accessor for the inner Document. Lets cargo test exercise the underlying state transitions without going through a JS shell.

Trait Implementations§

Source§

impl From<WasmDocument> for JsValue

Source§

fn from(value: WasmDocument) -> Self

Converts to this type from the input type.
Source§

impl FromWasmAbi for WasmDocument

Source§

type Abi = WasmPtr<WasmRefCell<WasmDocument>>

The Wasm ABI type that this converts from when coming back out from the ABI boundary.
Source§

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi. Read more
Source§

impl IntoWasmAbi for WasmDocument

Source§

type Abi = WasmPtr<WasmRefCell<WasmDocument>>

The Wasm ABI type that this converts into when crossing the ABI boundary.
Source§

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.
Source§

impl LongRefFromWasmAbi for WasmDocument

Source§

type Abi = WasmPtr<WasmRefCell<WasmDocument>>

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRef<WasmDocument>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl OptionFromWasmAbi for WasmDocument

Source§

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.
Source§

impl OptionIntoWasmAbi for WasmDocument

Source§

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more
Source§

impl RefFromWasmAbi for WasmDocument

Source§

type Abi = WasmPtr<WasmRefCell<WasmDocument>>

The Wasm ABI type references to Self are recovered from.
Source§

type Anchor = RcRef<WasmDocument>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.
Source§

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi. Read more
Source§

impl RefMutFromWasmAbi for WasmDocument

Source§

type Abi = WasmPtr<WasmRefCell<WasmDocument>>

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRefMut<WasmDocument>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl SupportsConstructor for WasmDocument

Source§

impl SupportsInstanceProperty for WasmDocument

Source§

impl SupportsStaticProperty for WasmDocument

Source§

impl TryFromJsValue for WasmDocument

Source§

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.
Source§

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.
Source§

impl VectorFromWasmAbi for WasmDocument

Source§

impl VectorIntoWasmAbi for WasmDocument

Source§

impl WasmDescribe for WasmDocument

Source§

impl WasmDescribeVector for WasmDocument

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> 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> ReturnWasmAbi for T
where T: IntoWasmAbi,

Source§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
Source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
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.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more