codecs/encoding/
mod.rs

1//! A collection of support structures that are used in the process of encoding
2//! events into bytes.
3
4pub mod chunking;
5mod config;
6mod encoder;
7pub mod format;
8pub mod framing;
9pub mod serializer;
10mod transformer;
11pub use chunking::{Chunker, Chunking, GelfChunker};
12pub use config::{EncodingConfig, EncodingConfigWithFraming, SinkType};
13pub use encoder::{BatchEncoder, BatchSerializer, Encoder, EncoderKind};
14#[cfg(feature = "arrow")]
15pub use format::{
16    ArrowEncodingError, ArrowStreamSerializer, ArrowStreamSerializerConfig, SchemaProvider,
17    find_null_non_nullable_fields,
18};
19pub use format::{
20    AvroSerializer, AvroSerializerConfig, AvroSerializerOptions, CefSerializer,
21    CefSerializerConfig, CsvSerializer, CsvSerializerConfig, GelfSerializer, GelfSerializerConfig,
22    JsonSerializer, JsonSerializerConfig, JsonSerializerOptions, LogfmtSerializer,
23    LogfmtSerializerConfig, NativeJsonSerializer, NativeJsonSerializerConfig, NativeSerializer,
24    NativeSerializerConfig, ProtobufSerializer, ProtobufSerializerConfig,
25    ProtobufSerializerOptions, RawMessageSerializer, RawMessageSerializerConfig, TextSerializer,
26    TextSerializerConfig,
27};
28#[cfg(feature = "opentelemetry")]
29pub use format::{OtlpSerializer, OtlpSerializerConfig};
30#[cfg(feature = "parquet")]
31pub use format::{
32    ParquetCompression, ParquetSchemaMode, ParquetSerializer, ParquetSerializerConfig,
33};
34#[cfg(feature = "syslog")]
35pub use format::{SyslogSerializer, SyslogSerializerConfig};
36pub use framing::{
37    BoxedFramer, BoxedFramingError, BytesEncoder, BytesEncoderConfig, CharacterDelimitedEncoder,
38    CharacterDelimitedEncoderConfig, CharacterDelimitedEncoderOptions, Framer, FramingConfig,
39    LengthDelimitedEncoder, LengthDelimitedEncoderConfig, NewlineDelimitedEncoder,
40    NewlineDelimitedEncoderConfig, VarintLengthDelimitedEncoder,
41    VarintLengthDelimitedEncoderConfig,
42};
43#[cfg(feature = "arrow")]
44pub use serializer::BatchSerializerConfig;
45pub use serializer::{Serializer, SerializerConfig};
46pub use transformer::{TimestampFormat, Transformer};
47
48/// An error that occurred while building an encoder.
49pub type BuildError = Box<dyn std::error::Error + Send + Sync + 'static>;
50
51/// An error that occurred while encoding structured events.
52#[derive(Debug)]
53pub enum Error {
54    /// The error occurred while encoding the byte frame boundaries.
55    FramingError(BoxedFramingError),
56    /// The error occurred while serializing a structured event into bytes.
57    SerializingError(vector_common::Error),
58    /// A schema constraint was violated during encoding (e.g., null value for non-nullable field).
59    SchemaConstraintViolation(vector_common::Error),
60}
61
62impl std::fmt::Display for Error {
63    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
64        match self {
65            Self::FramingError(error) => write!(formatter, "FramingError({error})"),
66            Self::SerializingError(error) => write!(formatter, "SerializingError({error})"),
67            Self::SchemaConstraintViolation(error) => {
68                write!(formatter, "SchemaConstraintViolation({error})")
69            }
70        }
71    }
72}
73
74impl std::error::Error for Error {}
75
76impl From<std::io::Error> for Error {
77    fn from(error: std::io::Error) -> Self {
78        Self::FramingError(Box::new(error))
79    }
80}
codecs/encoding/mod.rs

codecs/encoding/
mod.rs
