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
impl Env
Sourcepub fn get_binding<T: EnvBinding>(&self, name: &str) -> Result<T>
pub fn get_binding<T: EnvBinding>(&self, name: &str) -> Result<T>
Access a binding that does not have a wrapper in workers-rs. Useful for internal-only or unstable bindings.
pub fn ai(&self, binding: &str) -> Result<Ai>
Sourcepub fn secret(&self, binding: &str) -> Result<Secret>
pub fn secret(&self, binding: &str) -> Result<Secret>
Access Secret value bindings added to your Worker via the UI or wrangler
:
https://developers.cloudflare.com/workers/cli-wrangler/commands#secret
Sourcepub fn var(&self, binding: &str) -> Result<Var>
pub fn var(&self, binding: &str) -> Result<Var>
Get an environment variable defined in the [vars] section of your wrangler.toml or a secret
defined using wrangler secret
as a plaintext value.
See: https://developers.cloudflare.com/workers/configuration/environment-variables/
Sourcepub fn object_var<T: DeserializeOwned>(&self, binding: &str) -> Result<T>
pub fn object_var<T: DeserializeOwned>(&self, binding: &str) -> Result<T>
Get an environment variable defined in the [vars] section of your wrangler.toml that is defined as an object.
See: https://developers.cloudflare.com/workers/configuration/environment-variables/
Sourcepub fn kv(&self, binding: &str) -> Result<KvStore>
pub fn kv(&self, binding: &str) -> Result<KvStore>
Access a Workers KV namespace by the binding name configured in your wrangler.toml file.
Sourcepub fn durable_object(&self, binding: &str) -> Result<ObjectNamespace>
pub fn durable_object(&self, binding: &str) -> Result<ObjectNamespace>
Access a Durable Object namespace by the binding name configured in your wrangler.toml file.
Sourcepub fn dynamic_dispatcher(&self, binding: &str) -> Result<DynamicDispatcher>
pub fn dynamic_dispatcher(&self, binding: &str) -> Result<DynamicDispatcher>
Access a Dynamic Dispatcher for dispatching events to other workers.
Sourcepub fn service(&self, binding: &str) -> Result<Fetcher>
pub fn service(&self, binding: &str) -> Result<Fetcher>
Get a Service Binding for Worker-to-Worker communication.
Sourcepub fn queue(&self, binding: &str) -> Result<Queue>
pub fn queue(&self, binding: &str) -> Result<Queue>
Access a Queue by the binding name configured in your wrangler.toml file.
Sourcepub fn bucket(&self, binding: &str) -> Result<Bucket>
pub fn bucket(&self, binding: &str) -> Result<Bucket>
Access an R2 Bucket by the binding name configured in your wrangler.toml file.
Sourcepub fn d1(&self, binding: &str) -> Result<D1Database>
pub fn d1(&self, binding: &str) -> Result<D1Database>
Access a D1 Database by the binding name configured in your wrangler.toml file.
Sourcepub fn assets(&self, binding: &str) -> Result<Fetcher>
pub fn assets(&self, binding: &str) -> Result<Fetcher>
Access the worker assets by the binding name configured in your wrangler.toml file.
pub fn hyperdrive(&self, binding: &str) -> Result<Hyperdrive>
Methods from Deref<Target = JsValue>§
pub const NULL: JsValue
pub const UNDEFINED: JsValue
pub const TRUE: JsValue
pub const FALSE: JsValue
Sourcepub fn as_f64(&self) -> Option<f64>
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
.
Sourcepub fn as_string(&self) -> Option<String>
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
.
§UTF-16 vs UTF-8
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.
Sourcepub fn as_bool(&self) -> Option<bool>
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
.
Sourcepub fn is_undefined(&self) -> bool
pub fn is_undefined(&self) -> bool
Tests whether this JS value is undefined
Sourcepub fn is_function(&self) -> bool
pub fn is_function(&self) -> bool
Tests whether the type of this JS value is function
.
Sourcepub fn js_in(&self, obj: &JsValue) -> bool
pub fn js_in(&self, obj: &JsValue) -> bool
Applies the binary in
JS operator on the two JsValue
s.
Sourcepub fn loose_eq(&self, other: &JsValue) -> bool
pub fn loose_eq(&self, other: &JsValue) -> bool
Compare two JsValue
s for equality, using the ==
operator in JS.
Sourcepub fn unsigned_shr(&self, rhs: &JsValue) -> u32
pub fn unsigned_shr(&self, rhs: &JsValue) -> u32
Applies the binary >>>
JS operator on the two JsValue
s.
Sourcepub fn checked_div(&self, rhs: &JsValue) -> JsValue
pub fn checked_div(&self, rhs: &JsValue) -> JsValue
Applies the binary /
JS operator on two JsValue
s, catching and returning any RangeError
thrown.
Sourcepub fn pow(&self, rhs: &JsValue) -> JsValue
pub fn pow(&self, rhs: &JsValue) -> JsValue
Applies the binary **
JS operator on the two JsValue
s.
Sourcepub fn lt(&self, other: &JsValue) -> bool
pub fn lt(&self, other: &JsValue) -> bool
Applies the binary <
JS operator on the two JsValue
s.
Sourcepub fn le(&self, other: &JsValue) -> bool
pub fn le(&self, other: &JsValue) -> bool
Applies the binary <=
JS operator on the two JsValue
s.
Sourcepub fn ge(&self, other: &JsValue) -> bool
pub fn ge(&self, other: &JsValue) -> bool
Applies the binary >=
JS operator on the two JsValue
s.
Sourcepub fn gt(&self, other: &JsValue) -> bool
pub fn gt(&self, other: &JsValue) -> bool
Applies the binary >
JS operator on the two JsValue
s.
Sourcepub fn unchecked_into_f64(&self) -> f64
pub fn unchecked_into_f64(&self) -> f64
Applies the unary +
JS operator on a JsValue
. Can throw.
Trait Implementations§
Source§impl FromWasmAbi for Env
impl FromWasmAbi for Env
Source§impl<'a> IntoWasmAbi for &'a Env
impl<'a> IntoWasmAbi for &'a Env
Source§impl IntoWasmAbi for Env
impl IntoWasmAbi for Env
Source§impl JsCast for Env
impl JsCast for Env
Source§fn instanceof(val: &JsValue) -> bool
fn instanceof(val: &JsValue) -> bool
instanceof
check to see whether the JsValue
provided is an instance of this type. Read moreSource§fn unchecked_from_js(val: JsValue) -> Self
fn unchecked_from_js(val: JsValue) -> Self
Source§fn unchecked_from_js_ref(val: &JsValue) -> &Self
fn unchecked_from_js_ref(val: &JsValue) -> &Self
Source§fn has_type<T>(&self) -> boolwhere
T: JsCast,
fn has_type<T>(&self) -> boolwhere
T: JsCast,
T
. Read moreSource§fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
T
. Read moreSource§fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
T
. Read moreSource§fn unchecked_into<T>(self) -> Twhere
T: JsCast,
fn unchecked_into<T>(self) -> Twhere
T: JsCast,
Source§fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
Source§impl LongRefFromWasmAbi for Env
impl LongRefFromWasmAbi for Env
Source§impl OptionFromWasmAbi for Env
impl OptionFromWasmAbi for Env
Source§impl<'a> OptionIntoWasmAbi for &'a Env
impl<'a> OptionIntoWasmAbi for &'a Env
Source§impl OptionIntoWasmAbi for Env
impl OptionIntoWasmAbi for Env
Source§impl RefFromWasmAbi for Env
impl RefFromWasmAbi for Env
Source§type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
Self
are recovered from.Source§type Anchor = ManuallyDrop<Env>
type Anchor = ManuallyDrop<Env>
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.impl Send for Env
impl Sync for Env
Auto Trait Implementations§
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
Source§type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
IntoWasmAbi::Abi
Source§fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
.