Enum codecs::decoding::DeserializerConfig

pub enum DeserializerConfig {
    Bytes,
    Json(JsonDeserializerConfig),
    Protobuf(ProtobufDeserializerConfig),
    Syslog(SyslogDeserializerConfig),
    Native,
    NativeJson(NativeJsonDeserializerConfig),
    Gelf(GelfDeserializerConfig),
    Influxdb(InfluxdbDeserializerConfig),
    Avro {
        avro: AvroDeserializerOptions,
    },
    Vrl(VrlDeserializerConfig),
}

Deserializer configuration.

Variants

Bytes

Uses the raw bytes as-is.

Json(JsonDeserializerConfig)

Decodes the raw bytes as JSON.

Protobuf(ProtobufDeserializerConfig)

Decodes the raw bytes as protobuf.

Syslog(SyslogDeserializerConfig)

Decodes the raw bytes as a Syslog message.

Decodes either as the RFC 3164-style format (“old” style) or the RFC 5424-style format (“new” style, includes structured data).

Native

Decodes the raw bytes as native Protocol Buffers format.

This codec is experimental.

NativeJson(NativeJsonDeserializerConfig)

Decodes the raw bytes as native JSON format.

This codec is experimental.

Gelf(GelfDeserializerConfig)

Decodes the raw bytes as a GELF message.

This codec is experimental for the following reason:

The GELF specification is more strict than the actual Graylog receiver. Vector’s decoder currently adheres more strictly to the GELF spec, with the exception that some characters such as @ are allowed in field names.

Other GELF codecs such as Loki’s, use a Go SDK that is maintained by Graylog, and is much more relaxed than the GELF spec.

Going forward, Vector will use that Go SDK as the reference implementation, which means the codec may continue to relax the enforcement of specification.

Influxdb(InfluxdbDeserializerConfig)

Decodes the raw bytes as an Influxdb Line Protocol message.

Avro

Decodes the raw bytes as as an Apache Avro message.

Fields

avro: AvroDeserializerOptions

Apache Avro-specific encoder options.

Vrl(VrlDeserializerConfig)

Decodes the raw bytes as a string and passes them as input to a VRL program.

Implementations

impl DeserializerConfig

pub fn build(&self) -> Result<Deserializer>

Build the Deserializer from this configuration.

pub fn default_stream_framing(&self) -> FramingConfig

Return an appropriate default framer for the given deserializer

pub fn default_message_based_framing(&self) -> FramingConfig

Returns an appropriate default framing config for the given deserializer with message based inputs.

pub fn output_type(&self) -> DataType

Return the type of event build by this deserializer.

pub fn schema_definition(&self, log_namespace: LogNamespace) -> Definition

The schema produced by the deserializer.

pub const fn content_type(&self, framer: &FramingConfig) -> &'static str

Get the HTTP content type.

Trait Implementations

impl Clone for DeserializerConfig

fn clone(&self) -> DeserializerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for DeserializerConfig

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for DeserializerConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeserializerConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BytesDeserializerConfig> for DeserializerConfig

fn from(_: BytesDeserializerConfig) -> Self

Converts to this type from the input type.

impl From<GelfDeserializerConfig> for DeserializerConfig

fn from(config: GelfDeserializerConfig) -> Self

Converts to this type from the input type.

impl From<InfluxdbDeserializerConfig> for DeserializerConfig

fn from(config: InfluxdbDeserializerConfig) -> Self

Converts to this type from the input type.

impl From<JsonDeserializerConfig> for DeserializerConfig

fn from(config: JsonDeserializerConfig) -> Self

Converts to this type from the input type.

impl From<NativeDeserializerConfig> for DeserializerConfig

fn from(_: NativeDeserializerConfig) -> Self

Converts to this type from the input type.

impl From<NativeJsonDeserializerConfig> for DeserializerConfig

fn from(config: NativeJsonDeserializerConfig) -> Self

Converts to this type from the input type.

impl From<SyslogDeserializerConfig> for DeserializerConfig

fn from(config: SyslogDeserializerConfig) -> Self

Converts to this type from the input type.

impl Serialize for DeserializerConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for DeserializerConfig

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.