rbfrt 0.1.8

Rust library for interaction with Intel Tofino(TM) BFRT switch interface.
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

/* Copyright 2023-present University of Tuebingen, Chair of Communication Networks
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * Steffen Lindner (steffen.lindner@uni-tuebingen.de)
 */

use crate::table::ToBytes;

/// Represents a match value.
///
/// # Example
///
/// ```
/// use rbfrt::table::MatchValue;
/// MatchValue::lpm(vec![10u8, 0, 0, 2], 32);
/// ```

#[derive(Debug, Clone)]
pub enum MatchValue {
    ExactValue {
        bytes: Vec<u8>,
    },
    RangeValue {
        lower_bytes: Vec<u8>,
        higher_bytes: Vec<u8>,
    },
    LPM {
        bytes: Vec<u8>,
        prefix_length: i32,
    },
    Ternary {
        value: Vec<u8>,
        mask: Vec<u8>,
    },
}

impl MatchValue {
    /// Creates a new Exact match value
    ///
    /// # Example
    ///
    /// ```
    /// use rbfrt::table::MatchValue;
    /// MatchValue::exact(10);
    /// ```
    pub fn exact<T: ToBytes>(value: T) -> MatchValue {
        MatchValue::ExactValue {
            bytes: value.to_bytes(),
        }
    }

    pub fn get_exact_value(&self) -> &Vec<u8> {
        match self {
            MatchValue::ExactValue { bytes } => bytes,
            _ => panic!("No exact match value."),
        }
    }

    /// Creates a new Range match value
    ///
    /// # Example
    ///
    /// ```
    /// use rbfrt::table::MatchValue;
    /// MatchValue::range(20, 30);
    /// ```
    pub fn range<T: ToBytes>(lower: T, higher: T) -> MatchValue {
        MatchValue::RangeValue {
            lower_bytes: lower.to_bytes(),
            higher_bytes: higher.to_bytes(),
        }
    }

    pub fn get_range_value(&self) -> (&Vec<u8>, &Vec<u8>) {
        match self {
            MatchValue::RangeValue {
                lower_bytes,
                higher_bytes,
            } => (lower_bytes, higher_bytes),
            _ => panic!("No range match value."),
        }
    }

    /// Creates a new LPM match value
    ///
    /// # Example
    ///
    /// ```
    /// use rbfrt::table::MatchValue;
    /// MatchValue::lpm(vec![10u8, 0, 0, 2], 32);
    /// ```
    pub fn lpm<T: ToBytes>(value: T, prefix_length: i32) -> MatchValue {
        MatchValue::LPM {
            bytes: value.to_bytes(),
            prefix_length,
        }
    }

    /// Creates a new Ternary match value
    ///
    /// # Example
    ///
    /// ```
    /// use rbfrt::table::MatchValue;
    /// MatchValue::ternary(vec![7u8, 0, 7], vec![0u8, 0, 1]);
    /// ```
    pub fn ternary<T: ToBytes>(value: T, mask: T) -> MatchValue {
        MatchValue::Ternary {
            value: value.to_bytes(),
            mask: mask.to_bytes(),
        }
    }
}