Struct JavaScriptBuilderElementBuilder 

pub struct JavaScriptBuilderElementBuilder { /* private fields */ }

Configures and constructs a JavaScriptBuilderElement.

The defaults are minification on, cookies enabled, object name fod, the default JSON endpoint, and an empty host and protocol so the values from request evidence are used.

Example

use fiftyone_javascript_builder::JavaScriptBuilderElement;

let element = JavaScriptBuilderElement::builder()
    .set_object_name("myObj").unwrap()
    .set_protocol("https").unwrap()
    .set_minify(false)
    .build();

Implementations

impl JavaScriptBuilderElementBuilder

pub fn new() -> Self

Start a builder pre-populated with the defaults.

pub fn set_enable_cookies(self, enable_cookies: bool) -> Self

Set whether client-side processing stores results in cookies.

This can also be set per request through the query.fod-js-enable-cookies evidence key.

pub fn set_host(self, host: impl Into<String>) -> Self

Set the host the client JavaScript should query for updates. By default the host from the request evidence is used.

pub fn set_endpoint(self, endpoint: impl Into<String>) -> Self

Set the endpoint queried on the host, for example /api/v4/json.

pub fn set_protocol(self, protocol: impl Into<String>) -> Result<Self>

Set the protocol the client JavaScript uses when querying for updates.

Only http or https (case-insensitive) are accepted. Any other value is a configuration error.

pub fn set_object_name(self, object_name: impl Into<String>) -> Result<Self>

Set the default name of the object instantiated by the client JavaScript.

The name must be a valid JavaScript identifier (it must match [a-zA-Z_$][0-9a-zA-Z_$]* in full). An invalid name is a configuration error.

pub fn set_minify(self, minify: bool) -> Self

Enable or disable minification of the generated JavaScript.

Minification only takes effect when the crate’s minify feature is enabled (it is on by default). With the feature disabled this flag is retained but has no effect.

pub fn build(self) -> JavaScriptBuilderElement

Build the configured JavaScriptBuilderElement.

Trait Implementations

impl Clone for JavaScriptBuilderElementBuilder

fn clone(&self) -> JavaScriptBuilderElementBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JavaScriptBuilderElementBuilder

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

Formats the value using the given formatter.

impl Default for JavaScriptBuilderElementBuilder

fn default() -> Self

Returns the “default value” for a type.