Struct worker_plus::durable::ObjectNamespace

pub struct ObjectNamespace { /* private fields */ }

Use an ObjectNamespace to get access to Stubs for communication with a Durable Object instance. A given namespace can support essentially unlimited Durable Objects, with each Object having access to a transactional, key-value storage API.

Implementations

impl ObjectNamespace

pub fn id_from_name(&self, name: &str) -> Result<ObjectId<'_>>

This method derives a unique object ID from the given name string. It will always return the same ID when given the same name as input.

pub fn id_from_string(&self, hex_id: &str) -> Result<ObjectId<'_>>

This method parses an ID that was previously stringified. This is useful in particular with IDs created using unique_id(&self), as these IDs need to be stored somewhere, probably as

A stringified object ID is a 64-digit hexadecimal number. However, not all 64-digit hex numbers are valid IDs. This method will throw if it is passed an ID that was not originally created by newUniqueId() or idFromName(). It will also throw if the ID was originally created for a different namespace.

pub fn unique_id(&self) -> Result<ObjectId<'_>>

Creates a new object ID randomly. This method will never return the same ID twice, and thus it is guaranteed that the object does not yet exist and has never existed at the time the method returns.

pub fn unique_id_with_jurisdiction(&self, jd: &str) -> Result<ObjectId<'_>>

Durable Objects can be created so that they only run and store data within a specific jurisdiction to comply with local regulations. You must specify the jurisdiction when generating the Durable Object’s id.

Jurisdiction constraints can only be used with ids created by unique_id() and are not currently compatible with ids created by id_from_name().

See supported jurisdictions and more documentation at: https://developers.cloudflare.com/workers/runtime-apis/durable-objects#restricting-objects-to-a-jurisdiction

Trait Implementations

impl AsRef<JsValue> for ObjectNamespace

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl From<ObjectNamespace> for JsValue

fn from(ns: ObjectNamespace) -> Self

Converts to this type from the input type.

impl JsCast for ObjectNamespace

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> boolwhere
    T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>where
    T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T>where
    T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> Twhere
    T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &Twhere
    T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> boolwhere
    T: JsCast,

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.