ipfix-parser 0.2.0

IPFIX (RFC 7011) Parser
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
46
47
48
49
50
51
52

//! Parser error types

use std::fmt;

/// Parser error type
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ParseError {
    /// The input ended before a structure could be fully read
    Truncated {
        /// Structure being read
        context: &'static str,
        /// Octets needed
        needed: usize,
        /// Octets available
        available: usize,
    },
    /// Version Number is not 10 (IPFIX)
    InvalidVersion(u16),
    /// Invalid data format
    InvalidData(String),
    /// The decoder Template cache is full (see
    /// [`DecoderConfig::max_templates`](crate::DecoderConfig::max_templates))
    TemplateLimitExceeded(usize),
}

impl fmt::Display for ParseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ParseError::Truncated {
                context,
                needed,
                available,
            } => write!(
                f,
                "Truncated {}: needed {} octets, {} available",
                context, needed, available
            ),
            ParseError::InvalidVersion(v) => {
                write!(f, "Invalid version: {} (expected 10)", v)
            }
            ParseError::InvalidData(msg) => write!(f, "Invalid data: {}", msg),
            ParseError::TemplateLimitExceeded(limit) => {
                write!(f, "Template limit exceeded: {} templates", limit)
            }
        }
    }
}

impl std::error::Error for ParseError {}

/// Result type for parser operations
pub type Result<T> = std::result::Result<T, ParseError>;