varpulis-connector-api 0.9.0

Shared traits and types for Varpulis connector crates
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

//! Converter trait for standardized serialization/deserialization of events.

pub mod json;

use thiserror::Error;
use varpulis_core::Event;

/// Errors produced by converters.
#[derive(Debug, Error)]
pub enum ConverterError {
    /// Failed to deserialize raw bytes into events.
    #[error("deserialization failed: {0}")]
    DeserializeFailed(String),
    /// Failed to serialize an event into raw bytes.
    #[error("serialization failed: {0}")]
    SerializeFailed(String),
    /// The requested format is not supported.
    #[error("unsupported format: {0}")]
    UnsupportedFormat(String),
    /// Converter initialization failed.
    #[error("initialization failed: {0}")]
    InitFailed(String),
}

/// Trait for converting between raw bytes and Events.
pub trait Converter: Send + Sync {
    /// Human-readable name (e.g. `"json"`, `"csv"`).
    fn name(&self) -> &str;

    /// Deserialize raw bytes into one or more events.
    fn deserialize(&self, event_type: &str, payload: &[u8]) -> Result<Vec<Event>, ConverterError>;

    /// Serialize an event into raw bytes.
    fn serialize(&self, event: &Event) -> Result<Vec<u8>, ConverterError>;

    /// Optional initialization hook.
    fn init(&mut self) -> Result<(), ConverterError> {
        Ok(())
    }

    /// Optional shutdown hook.
    fn shutdown(&mut self) -> Result<(), ConverterError> {
        Ok(())
    }
}