Struct Decoder 

pub struct Decoder { /* private fields */ }

Stateful IPFIX decoder holding the Template cache of one Transport Session

Implementations

impl Decoder

pub fn new() -> Self

Create a decoder with the default configuration

pub fn with_config(config: DecoderConfig) -> Self

Create a decoder with a custom configuration

pub fn template_count(&self) -> usize

Number of Templates and Options Templates in the cache

pub fn has_template(&self, observation_domain_id: u32, template_id: u16) -> bool

Whether a Template (or Options Template) is known for this Observation Domain and Template ID

pub fn template_last_received( &self, observation_domain_id: u32, template_id: u16, ) -> Option<u32>

Export Time of the Message that last carried this Template (or Options Template), i.e. the “Last Received” of RFC 7011 Section 8.4

pub fn expire_templates(&mut self, now: u32)

Discard the Templates not refreshed within DecoderConfig::template_lifetime at time now (in seconds since the UNIX epoch, like the Export Time). This runs automatically for each decoded Message over UDP; call it to expire Templates with your own clock, e.g. when an Exporter stopped sending. Does nothing without a lifetime.

pub fn register_enterprise_element( &mut self, element: EnterpriseElement, ) -> Result<()>

Register the definition of an enterprise-specific Information Element (e.g. from vendor documentation), so that its fields are decoded with its data type instead of being kept as FieldValue::Raw.

Registered definitions apply to all Observation Domains, survive clear, and always take precedence over type records sent by the Exporter (RFC 5610 Section 3.9). Registering the same element again replaces the definition. Fails for reverse elements (PEN 29305) and for IANA elements already in the registry.

pub fn enterprise_element( &self, observation_domain_id: u32, enterprise_number: u32, id: u16, ) -> Option<&EnterpriseElement>

The definition of an enterprise-specific Information Element: the registered one, or else the one learned from type records (RFC 5610) in this Observation Domain. With enterprise_number 0, the definition of an IANA element newer than the registry.

pub fn learned_element_count(&self) -> usize

Number of enterprise-specific Information Element definitions learned from type records (RFC 5610), excluding conflicting ones

pub fn field_name( &self, observation_domain_id: u32, specifier: &FieldSpecifier, ) -> Option<&str>

The name of a field’s Information Element: the IANA name (forward name for reverse elements), or the name of its enterprise-specific definition

pub fn clear(&mut self)

Remove all Templates and learned type records (e.g. at the end of the Transport Session). Registered definitions are kept.

pub fn remove_observation_domain(&mut self, observation_domain_id: u32)

Remove all Templates and learned type records of an Observation Domain

pub fn decode(&mut self, data: &[u8]) -> Result<Message>

Decode one IPFIX Message, updating the Template cache.

Octets after the Message Length are ignored; use decode_all for a buffer holding several Messages.

pub fn decode_all(&mut self, data: &[u8]) -> Result<Vec<Message>>

Decode a buffer of consecutive IPFIX Messages (e.g. a TCP stream or an IPFIX File), updating the Template cache.

Trait Implementations

impl Clone for Decoder

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Decoder

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

Formats the value using the given formatter.

impl Default for Decoder

fn default() -> Self

Returns the “default value” for a type.