Struct TablesInput

pub struct TablesInput<'t> { /* private fields */ }

An object containing table-related vtables

It’s used as a token to prove you’re allowed to read/write tables or manage their fields

Implementations

impl TablesInput<'_>

pub fn list_tables(&self) -> &[ss_plugin_table_info]

List the available tables

Note: this method is of limited utility in actual plugin code (you know the tables you want to access), so it returns the unmodified structure from the plugin API, including raw pointers to C-style strings. This may change later.

pub fn get_table<T, K>(&self, name: &CStr) -> Result<T, Error>

where T: TableAccess<Key = K>, K: Key,

Import a table from the Falco plugin API

The key type is verified by the plugin API, so this method will return an error on mismatch

pub fn add_table<K, E>( &self, table: Table<K, E>, ) -> Result<Box<Table<K, E>>, Error>

where K: Key + Ord + Borrow<<K as Key>::Borrowed>, <K as Key>::Borrowed: Ord + ToOwned<Owned = K>, E: Entry, E::Metadata: TableMetadata,

Export a table to the Falco plugin API

This method returns a Box, which you need to store in your plugin instance even if you don’t intend to use the table yourself (the table is destroyed when going out of scope, which will lead to crashes in plugins using your table).

Trait Implementations

impl<'t> Debug for TablesInput<'t>

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

Formats the value using the given formatter.