Struct tremor_script::Script

pub struct Script { /* fields omitted */ }

A tremor script

Methods

impl Script

pub fn warnings(&self) -> &Vec<Warning>

Get script warnings

impl<'run, 'event, 'script> Script where
    'script: 'event,
    'event: 'run, 

pub fn parse(
    module_path: &ModulePath,
    file_name: &str,
    script: String,
    reg: &Registry
) -> Result<Self, CompilerError>

Parses a string and turns it into a script

pub fn docs(&self) -> &Docs

Returns the documentation for the script

pub fn highlight_script_with<H: Highlighter>(
    script: &str,
    h: &mut H
) -> Result<()>

Highlights a script with a given highlighter.

pub fn highlight_preprocess_script_with<H: Highlighter>(
    file_name: &str,
    script: &'script str,
    h: &mut H
) -> Result<()>

Preprocessesa and highlights a script with a given highlighter.

pub fn format_error_from_script<H: Highlighter>(
    script: &str,
    h: &mut H,
    CompilerError { error: error, cus: cus }: &CompilerError
) -> Result<()>

Format an error given a script source.

pub fn format_warnings_with<H: Highlighter>(&self, h: &mut H) -> Result<()>

Format an error given a script source.

pub fn format_error(&self, e: &Error) -> String

Formats an error within this script

pub fn format_error_with<H: Highlighter>(
    &self,
    h: &mut H,
    e: &Error
) -> Result<()>

Formats an error within this script using a given highlighter

pub fn run(
    &'script self,
    context: &'run EventContext,
    aggr: AggrType,
    event: &'run mut Value<'event>,
    state: &'run mut Value<'static>,
    meta: &'run mut Value<'event>
) -> Result<Return<'event>>

Runs an event through this script

Trait Implementations

impl Debug for Script

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

Formats the value using the given formatter.