Struct ywasm :: WeakLink Copy item path

impl YWeakLink

pub fn prelim(&self) -> bool

Returns true if this is a preliminary instance of YWeakLink.

Preliminary instances can be nested into other shared data types such as YArray and YMap. Once a preliminary instance has been inserted this way, it becomes integrated into ywasm document store and cannot be nested again: attempt to do so will result in an exception.

pub fn get_type(&self) -> u8

pub fn id(&self) -> Result<JsValue, JsValue>

Gets unique logical identifier of this type, shared across peers collaborating on the same document.

pub fn alive(&self, txn: &YTransaction) -> bool

Checks if current YWeakLink reference is alive and has not been deleted by its parent collection. This method only works on already integrated shared types and will return false is current type is preliminary (has not been integrated into document).

pub fn observe(&mut self, f: Function) -> Result<Observer, JsValue>

Subscribes to all operations happening over this instance of YMap. All changes are batched and eventually triggered during transaction commit phase. Returns an YObserver which, when free’d, will unsubscribe current callback.

pub fn observe_deep(&mut self, f: Function) -> Result<Observer, JsValue>

Subscribes to all operations happening over this Y shared type, as well as events in shared types stored within this one. All changes are batched and eventually triggered during transaction commit phase. Returns an YEventObserver which, when free’d, will unsubscribe current callback.

Trait Implementations§

impl From<YWeakLink> for JsValue

fn from(value: YWeakLink) -> Self

Converts to this type from the input type.

impl FromWasmAbi for YWeakLink

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi. Read more

impl IntoWasmAbi for YWeakLink

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

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

impl LongRefFromWasmAbi for YWeakLink

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = Ref<'static, YWeakLink>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for YWeakLink

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.

impl OptionIntoWasmAbi for YWeakLink

fn none() -> Self::Abi

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

impl RefFromWasmAbi for YWeakLink

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, YWeakLink>

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.