codecs/encoding/framing/
character_delimited.rs

1use bytes::{BufMut, BytesMut};
2use tokio_util::codec::Encoder;
3use vector_config::configurable_component;
4
5use super::BoxedFramingError;
6
7/// Config used to build a `CharacterDelimitedEncoder`.
8#[configurable_component]
9#[derive(Debug, Clone, Eq, PartialEq)]
10pub struct CharacterDelimitedEncoderConfig {
11    /// Options for the character delimited encoder.
12    pub character_delimited: CharacterDelimitedEncoderOptions,
13}
14
15impl CharacterDelimitedEncoderConfig {
16    /// Creates a `CharacterDelimitedEncoderConfig` with the specified delimiter.
17    pub const fn new(delimiter: u8) -> Self {
18        Self {
19            character_delimited: CharacterDelimitedEncoderOptions { delimiter },
20        }
21    }
22
23    /// Build the `CharacterDelimitedEncoder` from this configuration.
24    pub const fn build(&self) -> CharacterDelimitedEncoder {
25        CharacterDelimitedEncoder::new(self.character_delimited.delimiter)
26    }
27}
28
29/// Configuration for character-delimited framing.
30#[configurable_component]
31#[derive(Clone, Debug, Eq, PartialEq)]
32pub struct CharacterDelimitedEncoderOptions {
33    /// The ASCII (7-bit) character that delimits byte sequences.
34    #[configurable(metadata(docs::type_override = "ascii_char"))]
35    #[serde(with = "vector_core::serde::ascii_char")]
36    pub delimiter: u8,
37}
38
39/// An encoder for handling bytes that are delimited by (a) chosen character(s).
40#[derive(Debug, Clone)]
41pub struct CharacterDelimitedEncoder {
42    /// The character that delimits byte sequences.
43    pub delimiter: u8,
44}
45
46impl CharacterDelimitedEncoder {
47    /// Creates a `CharacterDelimitedEncoder` with the specified delimiter.
48    pub const fn new(delimiter: u8) -> Self {
49        Self { delimiter }
50    }
51}
52
53impl Encoder<()> for CharacterDelimitedEncoder {
54    type Error = BoxedFramingError;
55
56    fn encode(&mut self, _: (), buffer: &mut BytesMut) -> Result<(), BoxedFramingError> {
57        buffer.put_u8(self.delimiter);
58        Ok(())
59    }
60}
61
62#[cfg(test)]
63mod tests {
64    use super::*;
65
66    #[test]
67    fn encode() {
68        let mut codec = CharacterDelimitedEncoder::new(b'\n');
69
70        let mut buffer = BytesMut::from("abc");
71        codec.encode((), &mut buffer).unwrap();
72
73        assert_eq!(b"abc\n", &buffer[..]);
74    }
75}
codecs/encoding/framing/character_delimited.rs

codecs/encoding/framing/
character_delimited.rs
