Skip to main content

CompileOptions

Struct CompileOptions 

Source
pub struct CompileOptions {
    pub source_dir: Option<PathBuf>,
    pub lib_paths: Vec<PathBuf>,
    pub required_outputs: Vec<String>,
    pub strict: bool,
    pub context: String,
    pub cursor_limit: Option<u64>,
    pub ledger: Option<Arc<CompileLedger>>,
    pub resources: Option<ResourceScope>,
    pub engine: Engine,
    pub input_variance: InputVariance,
    pub inferred_externs: Vec<String>,
}
Expand description

The options every entry point compiles under. A host that names none gets the defaults: no source directory, no library paths, every binding an output, lax typing, the default context label, no cursor limit, and the most compiled engine this build has.

strict refuses what lax compilation warns about, on every engine: an implicit type coercion, a config wire fed from a cycle-time source, a nondeterministic node no volatile output acknowledges, a binding nothing reads, an undeclared coordinate, and a positional module argument. It is also pragma strict at the program’s top scope (polydat_grammar.md §14): strict value checks, strict type checks, and strict name checking hold in the program and in every scope that inherits its pragmas, and a module body follows its own pragmas alone.

engine is a preference, and the only place a caller expresses one. Leaving it alone is the normative path: Engine::default is the most native form the build offers (native code with the jit feature, the closure tier without), so a host that never mentions the field still gets compiled code, and gets faster code for free when a build gains a tier. Naming an engine is for testing, measurement, and demonstration — a differential test that wants the interpreter as the reference, a bench that walks the tiers. A preference the build cannot realize is refused (crate::KernelError::Refused) rather than silently replaced, and every kernel reports what it actually runs through crate::Kernel::engine.

Fields§

§source_dir: Option<PathBuf>

The directory relative data-file paths resolve against.

§lib_paths: Vec<PathBuf>

Library search paths, tried after the source directory and before the embedded standard library.

§required_outputs: Vec<String>

The outputs to keep; every output when empty.

§strict: bool

Whether to enforce strict validation, pragma strict at the program’s top scope included.

§context: String

The diagnostic context label, such as a file name.

§cursor_limit: Option<u64>

A limit on every cursor’s extent, if any.

§ledger: Option<Arc<CompileLedger>>

The compile ledger to record this program tree in: a host that holds one charges the compile to it; None mints a fresh one, read back through the kernel’s ledger().

§resources: Option<ResourceScope>

The resource scope of the program tree: a host that holds one, with or without an accessor installed, hands it here; None gives the tree a fresh, empty one, read back through the kernel’s resources() and installable there.

§engine: Engine

The engine to build on. Defaults to Engine::default, the most native form this build has; see the type’s documentation for when to set it and what happens when it cannot be realized.

§input_variance: InputVariance

What the compiler does with an input whose type the author did not declare (input_variance.md §4). The default, Fixed, makes the inferred type the input’s and refuses a write of another type.

§inferred_externs: Vec<String>

Externs whose declared type the caller inferred rather than the author wrote: the ones a program synthesizer emitted, such as a scope builder’s result and write-through externs. They are open to input_variance as an auto-extern is (input_variance.md §3).

Trait Implementations§

Source§

impl Clone for CompileOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CompileOptions

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for CompileOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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