Struct JsonPayload

pub struct JsonPayload<T> { /* private fields */ }

A wrapper that enables JSON-encoded event payloads in crate::event::AsyncEvent and crate::event::PluginEvent

To store an arbitrary type as JSON inside the payload, make sure the data implements Serialize and Deserialize from serde and use JsonPayload<T> as the payload type:

use falco_event::events::{AnyEventPayload, RawEvent};
use falco_plugin::event::{EventSource, JsonPayload, PluginEvent};
use falco_plugin::event::events::Event;

#[derive(serde::Serialize, serde::Deserialize)]
struct MyEvent {
    param1: u32,
    param2: u32,
}

impl EventSource for MyEvent {
    const SOURCE: Option<&'static str> = Some("my_plugin");
}

// in a plugin trait implementation:
type Event<'a> = Event<PluginEvent<JsonPayload<MyEvent>>>;

Note: this SDK provides JSON support since it’s already necessary to talk to the Falco Plugin API. JSON is not a good choice for high-volume events, as it takes a lot of space and is pretty slow, compared to binary formats. See the source of plugin::event:json for what is needed to support a different serialization format and consider using e.g. bincode instead.

Implementations

impl<T> JsonPayload<T>

pub fn new(inner: T) -> Self

Create a JsonPayload object from any data

pub fn get_ref(&self) -> &T

Get a reference to the data inside

pub fn get_mut(&mut self) -> &mut T

Get a mutable reference to the data inside

pub fn into_inner(self) -> T

Return the wrapped data, dropping the wrapper

Trait Implementations

impl<T> Debug for JsonPayload<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> EventSource for JsonPayload<T>

where T: EventSource,

const SOURCE: Option<&'static str> = T::SOURCE

Source name

impl<'a, T> FromBytes<'a> for JsonPayload<T>

where T: DeserializeOwned,

fn from_bytes(buf: &mut &'a [u8]) -> Result<Self, FromBytesError>

Read the binary representation of a field and return the parsed representation

fn from_maybe_bytes(buf: Option<&mut &'a [u8]>) -> Result<Self, FromBytesError>

Read the binary representation of a field from a buffer that may or may not exist

impl<T> ToBytes for JsonPayload<T>

where T: Serialize,

fn binary_size(&self) -> usize

Return the number of bytes needed to store the field

fn write<W: Write>(&self, writer: W) -> Result<()>

Write the binary representation to writer

fn default_repr() -> impl ToBytes

Return the default representation for the field type