Skip to main content

HostContext

Struct HostContext 

Source
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>

Source

pub fn js(&self) -> &'a Context

Direct JavaScriptCore API; UI/VM thread only.

Source

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.

Source

pub fn dispatcher(&self) -> JsDispatcher

A bounded worker-to-VM queue. Capture owned Rust data, never JSC values.

Source

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.

Source

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.

Source

pub fn surface(&self, name: &str) -> SurfaceHandle

The surface <sk-surface name="…"> elements show: present frames to it from any thread.

Source

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.

Source

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.

Source

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.

Source

pub fn storage_dir(&self) -> Result<PathBuf, String>

Provisions a cookie, including HttpOnly cookies, before the first request.

Source

pub fn random_bytes(&self, bytes: &mut [u8]) -> Result<(), String>

Source

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.

Source

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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>

Convert 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)

Convert &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)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts 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
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more