pub struct HostContext<'a> { /* private fields */ }Expand description
Services available after storage is installed and before any application JS runs.
Cookie and secret operations need the storages feature; secrets are sealed by the OS provider, no plaintext fallback.
Implementations§
Source§impl<'a> HostContext<'a>
impl<'a> HostContext<'a>
Sourcepub fn expose(&self, name: &str, value: Value) -> Result<()>
pub fn expose(&self, name: &str, value: Value) -> Result<()>
Installs a native namespace before app code, built with js.object, js.set and sk_app::js::function.
Sourcepub fn dispatcher(&self) -> JsDispatcher
pub fn dispatcher(&self) -> JsDispatcher
A bounded worker-to-VM queue. Capture owned Rust data, never JSC values.
Sourcepub fn handle(&self) -> Handle
pub fn handle(&self) -> Handle
The running app’s super::Handle, for UI that outlives setup (a tray icon). On macOS it
is the only way to one: run_on_main_thread returns no handle.
Sourcepub fn runtime(&self) -> &'a JsRuntime
pub fn runtime(&self) -> &'a JsRuntime
The engine’s runtime, for an extension built against the same sk-runtime that registers
__sk_* host fns, which Self::expose refuses on purpose. Prefer expose.
Sourcepub fn surface(&self, name: &str) -> SurfaceHandle
pub fn surface(&self, name: &str) -> SurfaceHandle
The surface <sk-surface name="…"> elements show: present frames to it from any thread.
Sourcepub fn on_frame(&self, hook: impl Fn() + 'static)
pub fn on_frame(&self, hook: impl Fn() + 'static)
Called on the VM thread once per frame before the frame’s wave drains: deliver what worker threads queued here, so a JS handler never observes a half-applied patch. Keep it bounded; it is on the frame’s critical path. Runs until shutdown.
Sourcepub fn on_reload(&self, hook: impl Fn(&Context) + 'static)
pub fn on_reload(&self, hook: impl Fn(&Context) + 'static)
Called on the VM thread after old-page teardown, before its replacement. Clear and unprotect page-owned callbacks here. The namespace remains installed.
Sourcepub fn on_shutdown(&self, hook: impl Fn(&Context) + 'static)
pub fn on_shutdown(&self, hook: impl Fn(&Context) + 'static)
Called once on the VM thread during orderly shutdown. Release protected callbacks here; stopping workers is the embedder’s job.
pub fn storage_dir(&self) -> Result<PathBuf, String>
Provisions a cookie, including HttpOnly cookies, before the first request.
pub fn random_bytes(&self, bytes: &mut [u8]) -> Result<(), String>
Sourcepub fn read_secret(&self, name: &str) -> Result<Option<String>, String>
pub fn read_secret(&self, name: &str) -> Result<Option<String>, String>
Only an absent file returns Ok(None); a corrupt or undecryptable secret is an error.
pub fn write_secret(&self, name: &str, value: &str) -> Result<(), String>
Auto Trait Implementations§
impl<'a> !Send for HostContext<'a>
impl<'a> !Sync for HostContext<'a>
impl<'a> Forget for HostContext<'a>
impl<'a> Freeze for HostContext<'a>
impl<'a> Move for HostContext<'a>
impl<'a> RefUnwindSafe for HostContext<'a>
impl<'a> Unpin for HostContext<'a>
impl<'a> UnsafeUnpin for HostContext<'a>
impl<'a> UnwindSafe for HostContext<'a>
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.impl<S, T> Duplex<S> for Twhere
T: FromSample<S> + ToSample<S>,
impl<T> ErasedDestructor for Twhere
T: 'static,
Source§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more