Skip to main content

Module embed

Module embed 

Source
Expand description

Default embedding API centered on a runtime-owning shell.

Most embedders should start with Shell, which owns both the runtime and the mutable shell session. Use ShellBuilder to assemble one shell or produce a reusable ShellBlueprint only when you intentionally need the advanced borrowed-runtime path.

Re-exports§

pub use crate::builtin::BuildError;
pub use crate::policy::ShellIdentity;
pub use crate::policy::ShellLanguage;
pub use crate::policy::ShellOptionSchema;
pub use crate::policy::ShellOptionSpec;
pub use crate::policy::ShellOptions;
pub use crate::policy::ShellSecurityPolicy;
pub use crate::policy::StartupPolicy;
pub use crate::policy::StartupSources;
pub use crate::policy::VariableAttributes;

Structs§

NamedFileDescriptor
A named inherited fd mapping exposed to child processes.
RunOutcome
Result returned from shell evaluation.
Shell
Primary runtime-owning embedding API.
ShellBlueprint
A reusable shell blueprint built once and cloned into advanced sessions or runtime-owning shells.
ShellBuilder
Fluent shell assembly that validates on build instead of in the middle of a method chain.
ShellDiagnostic
Collected parse or execution metadata returned from shell evaluation.
StdioConfig
File descriptors to use as the shell’s standard input, output, and error.

Enums§

DeferredWorkDetail
Structured detail for deferred work recorded in the trace.
DeferredWorkKind
Kind of deferred work recorded in the returned trace.
DiagnosticCategory
Host-facing category for a collected shell diagnostic.
DiagnosticKind
Severity level for a collected shell diagnostic.
TraceEvent
Ordered execution trace returned from shell evaluation.

Type Aliases§

PreparedProgram
The prepared-program type returned from the default runtime-owning shell API.