Struct worker::Env

source · [−]

#[repr(transparent)]
pub struct Env { /* private fields */ }

Expand description

Env contains any bindings you have associated with the Worker when you uploaded it.

Implementations

source

impl Env

source

pub fn secret(&self, binding: &str) -> Result<StringBinding>

Access Secret value bindings added to your Worker via the UI or wrangler: https://developers.cloudflare.com/workers/cli-wrangler/commands#secret

source

pub fn var(&self, binding: &str) -> Result<StringBinding>

Environment variables are defined via the [vars] configuration in your wrangler.toml file and are always plaintext values.

source

pub fn kv(&self, binding: &str) -> Result<KvStore>

Access a Workers KV namespace by the binding name configured in your wrangler.toml file.

source

pub fn durable_object(&self, binding: &str) -> Result<ObjectNamespace>

Access a Durable Object namespace by the binding name configured in your wrangler.toml file.

Methods from Deref<Target = JsValue>

source

pub const NULL: JsValue

source

pub const TRUE: JsValue

source

pub fn into_serde<T>(&self) -> Result<T, Error> where
T: for<'a> Deserialize<'a>,

Invokes JSON.stringify on this value and then parses the resulting JSON into an arbitrary Rust value.

This function will first call JSON.stringify on the JsValue itself. The resulting string is then passed into Rust which then parses it as JSON into the resulting value.

Usage of this API requires activating the serde-serialize feature of the wasm-bindgen crate.

Errors

Returns any error encountered when parsing the JSON into a T.

source

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

source

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

source

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

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

source

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

source

pub fn is_null(&self) -> bool

Tests whether this JS value is null

source

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

source

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

source

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

source

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

source

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is function.

source

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

source

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

source

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

source

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

source

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

source

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

source

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

source

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

source

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

source

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

source

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

source

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

source

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

source

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

source

impl AsRef<Env> for Env

source

fn as_ref(&self) -> &Env

Performs the conversion.

source

impl AsRef<JsValue> for Env

source

fn as_ref(&self) -> &JsValue

Performs the conversion.

source

impl Deref for Env

type Target = JsValue

The resulting type after dereferencing.

source

fn deref(&self) -> &JsValue

Dereferences the value.

source

impl From<Env> for JsValue

source

fn from(obj: Env) -> JsValue

Performs the conversion.

source

impl From<JsValue> for Env

source

fn from(obj: JsValue) -> Env

Performs the conversion.

source

impl FromWasmAbi for Env

type Abi = <JsValue as FromWasmAbi>::Abi

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

source

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

Recover a Self from Self::Abi. Read more

source

impl IntoWasmAbi for Env

type Abi = <JsValue as IntoWasmAbi>::Abi

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

source

fn into_abi(self) -> Self::Abi

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

source

impl<'a> IntoWasmAbi for &'a Env

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

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

source

fn into_abi(self) -> Self::Abi

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

source

impl JsCast for Env

source

fn instanceof(val: &JsValue) -> bool

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

source

fn unchecked_from_js(val: JsValue) -> Self

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

source

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

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

source

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

Test whether this JS value has a type T. Read more

source

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. Read more

source

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. Read more

source

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

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

source

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

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

source

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

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

source

fn is_type_of(val: &JsValue) -> bool

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

source

impl OptionFromWasmAbi for Env

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. Read more

source

impl OptionIntoWasmAbi for Env

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<'a> OptionIntoWasmAbi for &'a Env

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 Env

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Env>

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. Read more

source