# Functions
BloblangFunctionsMarkdown returns a markdown document for all Bloblang functions.
BloblangMethodsMarkdown returns a markdown document for all Bloblang methods.
ComponentFieldsFromConf walks the children of a YAML node and returns a list of fields extracted from it.
FieldAdvanced returns a field spec for an advanced field.
FieldBloblang returns a field spec for a string typed field containing a Bloblang mapping.
FieldBool returns a field spec for a common bool typed field.
FieldCommon returns a field spec for a common field.
FieldComponent returns a field spec for a component.
FieldDeprecated returns a field spec for a deprecated field.
FieldFloat returns a field spec for a common float typed field.
FieldFromYAML infers a field spec from a YAML node.
FieldInt returns a field spec for a common int typed field.
FieldInterpolatedString returns a field spec for a string typed field supporting dynamic interpolated functions.
FieldObject returns a field spec for an object typed field.
FieldsFromConf attempts to infer field documents from a config struct.
FieldsFromYAML walks the children of a YAML node and returns a list of fields extracted from it.
FieldsTemplate returns a Go template for rendering markdown field documentation.
FieldString returns a field spec for a common string typed field.
GetDocs attempts to locate a documentation spec for a component identified by a unique name and type combination.
GetInferenceCandidate checks a generic config structure for a component and returns either the inferred type name or an error if one cannot be inferred.
GetInferenceCandidateFromYAML checks a yaml node config structure for a component and returns either the inferred type name or an error if one cannot be inferred.
GetPluginConfigYAML extracts a plugin configuration node from a component config.
GetYAMLPath attempts to obtain a specific value within a YAML tree by following a sequence of path identifiers.
LintBloblangField is function for linting a config field expected to be an interpolation string.
LintBloblangMapping is function for linting a config field expected to be a bloblang mapping.
LintYAML takes a yaml.Node and a config spec and returns a list of linting errors found in the config.
NewLintContext creates a new linting context.
NewLintError returns an error lint.
NewLintWarning returns a warning lint.
NewMappedDocsProvider creates a new (empty) provider of component docs.
RegisterDocs stores the documentation spec for a component.
SanitiseComponentConfig reduces a raw component configuration into only the fields for the component name configured.
SanitiseYAML takes a yaml.Node and a config spec and sorts the fields of the node according to the spec.
ShouldDropDeprecated returns a field filter that removes all deprecated fields when the boolean argument is true.
Types returns a slice containing all component types.
ValidateLabel attempts to validate the contents of a component label.
# Variables
ErrBadLabel is returned when creating a component with a bad label.
ValueType variants.
ValueType variants.
ValueType variants.
ValueType variants.
ValueType variants.
Core component types, only components that can be a child of another component config are listed here.
ValueType variants.
ValueType variants.
ValueType variants.
ValueType variants.
ValueType variants.
ValueType variants.
ValueType variants.
ValueType variants.
ValueType variants.
ValueType variants.
ValueType variants.
ValueType variants.
ValueType variants.
Component statuses.
Component statuses.
Component statuses.
Component statuses.
Component types.
Component types.
Component types.
Component types.
Component types.
Component types.
Component types.
Component types.
# Structs
AnnotatedExample is an isolated example for a component.
ComponentSpec describes a Benthos component.
FieldSpec describes a component config field.
FieldSpecCtx provides a field spec and rendered extras for documentation templates to use.
Lint describes a single linting issue found with a Benthos config.
LintContext is provided to linting functions, and provides context about the wider configuration.
MappedDocsProvider stores component documentation in maps, protected by a mutex, allowing safe concurrent use.
SanitiseConfig contains fields describing the desired behaviour of the config sanitiser such as removing certain fields.
ToValueConfig describes custom options for how documentation fields should be used to convert a parsed node to a value type.
# Interfaces
Provider stores the component spec definitions of various component implementations.
# Type aliases
FieldFilter defines a filter closure that returns a boolean for a component field indicating whether the field should be kept within a generated config.
FieldKind represents a field kind.
FieldSpecs is a slice of field specs for a component.
FieldType represents a field type.
LintFunc is a common linting function for field values.
LintLevel describes the severity level of a linting error.
Status of a component.
Type of a component.