Struct ContextBuilder

pub struct ContextBuilder { /* private fields */ }

Builder for the Context type.

This builder allows custom initialization of the Interner within the context.

Implementations

impl ContextBuilder

pub fn new() -> Self

Creates a new ContextBuilder with a default empty Interner and a default BoaProvider if the intl feature is enabled.

pub fn interner(self, interner: Interner) -> Self

Initializes the context Interner to the provided interner.

This is useful when you want to initialize an Interner with a collection of words before parsing.

pub fn icu_buffer_provider<T: BufferProvider + 'static>( self, provider: T, ) -> Result<Self, IcuError>

Provides a BufferProvider data provider to the Context.

This function is only available if the intl feature is enabled.

Additional considerations

If the data was generated using icu_datagen, make sure that the deduplication strategy is not set to Maximal. Otherwise, icu_datagen will delete base locales such as “en” from the list of supported locales if the required data for “en” is the same as “und”. We recommend RetainBaseLanguages as a nice default, which will only deduplicate locales if the deduplication target is not “und”.

Errors

This returns Err if the provided provider doesn’t have the required locale information to construct both a LocaleCanonicalizer and a LocaleExpander. Note that this doesn’t mean that the provider will successfully construct all Intl services; that check is made until the creation of an instance of a service.

pub fn icu_any_provider<T: AnyProvider + 'static>( self, provider: T, ) -> Result<Self, IcuError>

Provides an AnyProvider data provider to the Context.

This function is only available if the intl feature is enabled.

Additional considerations

If the data was generated using icu_datagen, make sure that the deduplication strategy is not set to Maximal. Otherwise, icu_datagen will delete base locales such as “en” from the list of supported locales if the required data for “en” is the same as “und”. We recommend RetainBaseLanguages as a nice default, which will only deduplicate locales if the deduplication target is not “und”.

Errors

This returns Err if the provided provider doesn’t have the required locale information to construct both a LocaleCanonicalizer and a LocaleExpander. Note that this doesn’t mean that the provider will successfully construct all Intl services; that check is made until the creation of an instance of a service.

pub fn host_hooks<H: HostHooks + 'static>(self, host_hooks: &'static H) -> Self

Initializes the HostHooks for the context.

pub fn job_queue<Q: JobQueue + 'static>(self, job_queue: Rc<Q>) -> Self

Initializes the JobQueue for the context.

pub fn module_loader<M: ModuleLoader + 'static>( self, module_loader: Rc<M>, ) -> Self

Initializes the ModuleLoader for the context.

pub const fn can_block(self, can_block: bool) -> Self

AgentCanSuspend ( ) aka [[CanBlock]]

Defines if this context can be suspended by calls to the Atomics.wait function.

Note

By the specification, multiple agents cannot share the same thread if any of them has its [[CanBlock]] field set to true. The builder will verify at build time that all contexts on the current thread fulfill this requisite.

pub const fn instructions_remaining(self, instructions_remaining: usize) -> Self

Specifies the number of instructions remaining to the Context.

This function is only available if the fuzz feature is enabled.

pub fn build(self) -> JsResult<Context>

Builds a new Context with the provided parameters, and defaults all missing parameters to their default values.

Trait Implementations

impl Debug for ContextBuilder

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

Formats the value using the given formatter.

impl Default for ContextBuilder

fn default() -> ContextBuilder

Returns the “default value” for a type.