falco_plugin 0.5.1

High level bindings for the Falco plugin API
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

use crate::plugin::exported_tables::metadata::HasMetadata;
use anyhow::Error;
use std::ffi::CStr;
use std::ops::{Deref, DerefMut};

/// Do not export the field via Falco tables API
///
/// This is a wrapper that tells the Rust SDK not to export a field to other plugins.
/// It can be used to hold private plugin data or hold types that aren't supported
/// by the API (collections, enums etc.)
///
/// This type implements [`Deref`] and [`DerefMut`], so you do not need any extra
/// code when accessing the actual data.
///
/// **Note**: the wrapped type must implement [`Default`] as entries may be created
/// over the plugin API without any interaction with your plugin code.
#[derive(Debug)]
pub struct Private<T>(T);

impl<T> Deref for Private<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<T> DerefMut for Private<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl<T: Default> HasMetadata for Private<T> {
    type Metadata = ();

    fn new_with_metadata(_tag: &'static CStr, _meta: &Self::Metadata) -> Result<Self, Error> {
        Ok(Self(T::default()))
    }
}