Struct StableRef 

pub struct StableRef {
    pub id: String,
    pub version: Option<String>,
    pub server: String,
}

A stable reference to a document in the database.

Such a reference identifies a specific document, possibly at a specific version. The keys are prefixed with an underscore, e.g. _id instead of id, to avoid conflicts with other keys and unambiguously signal that the data occur at the database level, rather than merely the document level. The same convention is used in document databases like CouchDB and MongoDB.

Fields

id: String

Unique identifier of the referenced document.

When using CatColab’s official backend, this should be a document ref ID (a UUID).

version: Option<String>

Version of the document.

If null, refers to the head commit of document. This is the case when the referenced document will receive live updates.

server: String

Server containing the document.

Assuming one of the official deployments is used, this will be either catcolab.org or next.catcolab.org.

Trait Implementations

impl Debug for StableRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StableRef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<StableRef> for JsValue

where StableRef: Serialize,

fn from(value: StableRef) -> Self

Converts to this type from the input type.

impl FromWasmAbi for StableRef

where Self: DeserializeOwned,

type Abi = <JsType as FromWasmAbi>::Abi

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

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

Recover a Self from Self::Abi.

impl IntoWasmAbi for StableRef

where StableRef: Serialize,

type Abi = <JsType as IntoWasmAbi>::Abi

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

fn into_abi(self) -> Self::Abi

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

impl OptionFromWasmAbi for StableRef

where Self: DeserializeOwned,

fn is_none(js: &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 StableRef

where StableRef: Serialize,

fn none() -> Self::Abi

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

impl PartialEq for StableRef

fn eq(&self, other: &StableRef) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefFromWasmAbi for StableRef

where Self: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = SelfOwner<StableRef>

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.

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

Recover a Self::Anchor from Self::Abi.

impl Serialize for StableRef

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Tsify for StableRef

const DECL: &'static str = "/**\n * A stable reference to a document in the database.\n *\n * Such a reference identifies a specific document, possibly at a specific\n * version. The keys are prefixed with an underscore, e.g. `_id` instead of\n * `id`, to avoid conflicts with other keys and unambiguously signal that the\n * data occur at the *database* level, rather than merely the *document* level.\n * The same convention is used in document databases like CouchDB and MongoDB.\n */\nexport interface StableRef {\n /**\n * Unique identifier of the referenced document.\n *\n * When using CatColab\\\'s official backend, this should be a document ref ID\n * (a UUID).\n */\n _id: string;\n /**\n * Version of the document.\n *\n * If null, refers to the head commit of document. This is the case when\n * the referenced document will receive live updates.\n */\n _version: string | null;\n /**\n * Server containing the document.\n *\n * Assuming one of the official deployments is used, this will be either\n * `catcolab.org` or `next.catcolab.org`.\n */\n _server: string;\n}"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

fn into_js(&self) -> Result<Self::JsType, Error>

where Self: Serialize,

fn from_js<T>(js: T) -> Result<Self, Error>

where T: Into<JsValue>, Self: DeserializeOwned,

impl VectorFromWasmAbi for StableRef

where Self: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Self]>

impl VectorIntoWasmAbi for StableRef

where StableRef: Serialize,

type Abi = <JsType as VectorIntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Self]>) -> Self::Abi

impl WasmDescribe for StableRef

fn describe()

impl WasmDescribeVector for StableRef

fn describe_vector()

impl Eq for StableRef

impl StructuralPartialEq for StableRef