# Functions
ArrayMethod creates a general method signature from an array method by performing type checking on the method target.
BoolMethod creates a general method signature from a bool method by performing type checking on the method target.
BytesMethod creates a general method signature from a byte slice method by performing type checking on the method target.
Float64Method creates a general method signature from a float method by performing type checking on the method target.
GlobalEnvironment returns the global default environment.
Int64Method creates a general method signature from an int method by performing type checking on the method target.
NewAnyParam creates a new parameter that can be any type.
NewArgSpec creates an argument parser/validator.
NewBoolParam creates a new bool typed parameter.
NewEmptyEnvironment creates a fresh Bloblang environment starting completely empty, where no functions or methods are initially available.
NewEnvironment creates a fresh Bloblang environment, starting with the full range of globally defined features (functions and methods), and provides APIs for expanding or contracting the features available to this environment.
NewFloat64Param creates a new float64 typed parameter.
NewInt64Param creates a new 64-bit integer typed parameter.
NewPluginSpec creates a new plugin definition for a function or method plugin that describes the arguments that the plugin expects.
NewQueryParam creates a new advanced parameter that can yield any value and is encapsulated as an ExecFunction.
NewStringParam creates a new string typed parameter.
NewTimestampParam creates a new timestamp typed parameter.
ObjectMethod creates a general method signature from an object method by performing type checking on the method target.
Parse a Bloblang mapping allowing the use of the globally accessible range of features (functions and methods).
RegisterAdvancedFunction adds a new advanced Bloblang function to the global environment.
RegisterAdvancedMethod adds a new advanced Bloblang method to the global environment.
RegisterFunction adds a new Bloblang function to the global environment.
RegisterFunctionV2 adds a new Bloblang function to the global environment.
RegisterMethod adds a new Bloblang method to the global environment.
RegisterMethodV2 adds a new Bloblang method to the global environment.
StringMethod creates a general method signature from a string method by performing type checking on the method target.
TimestampMethod creates a general method signature from a timestamp method by performing type checking on the method target.
ValueAsBytes takes a boxed value and attempts to return a byte slice value.
ValueAsFloat32 takes a boxed value and attempts to extract a number from it.
ValueAsFloat64 takes a boxed value and attempts to extract a number from it.
ValueAsInt64 takes a boxed value and attempts to extract a number from it.
ValueAsTimestamp takes a boxed value and attempts to coerce it into a timestamp, either by interpretting a numerical value as a unix timestamp, or by parsing a string value as RFC3339Nano.
ValueSanitized takes a boxed value of any type and attempts to convert it into one of the following types: string, []byte, int64, uint64, float64, bool, []interface{}, map[string]interface{}, Delete, Nothing.
ValueToString converts any value into a string according to the same rules that other native bento components including bloblang would follow, where simple value types are stringified, but complex types are converted into JSON marshalled as a string.
XWrapEnvironment is for internal use only, do not use this.
# Variables
ErrRootDeleted is returned by a Bloblang query when the mapping results in the root being deleted.
# Structs
ArgError represents an error encountered when parsing a function or method argument.
ArgSpec provides an API for validating and extracting function or method arguments by registering them with pointer receivers.
Environment provides an isolated Bloblang environment where the available features, functions and methods can be modified.
ExecContext is an optional context provided to advanced functions and methods that contains information about a given mapping at the time the function/method is executed.
ExecFunction represents an active Bloblang function that can be executed by providing it an ExecContext.
Executor stores a parsed Bloblang mapping and provides APIs for executing it.
FunctionView describes a particular function belonging to a Bloblang environment.
MethodView describes a particular method belonging to a Bloblang environment.
ParamDefinition describes a single parameter for a function or method.
ParsedParams is a reference to the arguments of a method or function instantiation.
ParseError is a structured error type for Bloblang parser errors that provides access to information such as the line and column where the error occurred.
PluginSpec documents and defines the parameters of a function or method and the way in which it should be used.
TemplateExampleData describes a single example for a given bloblang plugin.
TemplateFunctionData describes a bloblang function.
TemplateMethodCategoryData describes a behaviour, along with examples, of a method plugin for a given category.
TemplateMethodData describes a bloblang method.
TemplateParamData describes a single parameter defined for a bloblang plugin.
TemplateParamsData describes the overall set of parameters for a bloblang plugin.
# Type aliases
AdvancedFunction defines a Bloblang function that accesses the execution context of the mapping during invocation.
AdvancedFunctionConstructor defines a constructor for a Bloblang function where parameters are parsed using a ParamsSpec provided when registering the function, and the constructed function is provided an ExecContext.
AdvancedMethod defines a Bloblang method that accesses the execution context of the mapping during invocation.
AdvancedMethodConstructor defines a constructor for a Bloblang method where parameters are parsed using a ParamsSpec provided when registering the method, and the constructed method is provided an ExecContext.
Function defines a Bloblang function, arguments are provided to the constructor, allowing the implementation of this function to resolve them statically when possible.
FunctionConstructor defines a constructor for a Bloblang function, where a variadic list of arguments are provided.
FunctionConstructorV2 defines a constructor for a Bloblang function where parameters are parsed using a ParamsSpec provided when registering the function.
Method defines a Bloblang function that executes on a value.
MethodConstructor defines a constructor for a Bloblang method, where a variadic list of arguments are provided.
MethodConstructorV2 defines a constructor for a Bloblang method where parameters are parsed using a ParamsSpec provided when registering the method.