wfp 0.0.6

A Rust library for the Windows Filtering Platform (WFP) 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
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

//! Filter weight types for controlling evaluation order within a sublayer.

use std::fmt;

/// Weight controlling filter evaluation order within a sublayer.
///
/// Higher weight means the filter is evaluated first. See the
/// [Filter Arbitration](https://docs.microsoft.com/en-us/windows/win32/fwp/filter-arbitration)
/// documentation for details.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum FilterWeight {
    /// Let BFE generate a weight in the range [0, 2^60).
    ///
    /// This corresponds to [`FWP_EMPTY`].
    ///
    /// [`FWP_EMPTY`]: https://learn.microsoft.com/en-us/windows/win32/api/fwpmtypes/ns-fwpmtypes-fwpm_filter0
    Auto,
    /// Specify a weight in [0, 15). The low-order 60 bits are automatically generated but the
    /// high-order 4 bits are specified here.
    ///
    /// This corresponds to [`FWP_UINT8`].
    ///
    /// [`FWP_UINT8`]: https://learn.microsoft.com/en-us/windows/win32/api/fwpmtypes/ns-fwpmtypes-fwpm_filter0
    Range(WeightRange),
    /// Specify an exact weight.
    ///
    /// This corresponds to [`FWP_UINT64`].
    ///
    /// [`FWP_UINT64`]: https://learn.microsoft.com/en-us/windows/win32/api/fwpmtypes/ns-fwpmtypes-fwpm_filter0
    Exact(u64),
}

/// A weight in the range 0-15.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct WeightRange(u8);

impl WeightRange {
    /// Returns the inner value.
    pub const fn get(self) -> u8 {
        self.0
    }
}

impl TryFrom<u8> for WeightRange {
    type Error = WeightRangeError;

    /// A value between 0 and 15 (inclusive).
    fn try_from(val: u8) -> Result<Self, Self::Error> {
        if val > 15 {
            Err(WeightRangeError(val))
        } else {
            Ok(Self(val))
        }
    }
}

/// Error returned when a value exceeds the valid weight range (0-15).
#[derive(Debug, Clone, Copy)]
pub struct WeightRangeError(u8);

impl fmt::Display for WeightRangeError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "weight range value {} is out of bounds (must be 0..=15)",
            self.0
        )
    }
}

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

impl From<WeightRange> for FilterWeight {
    fn from(range: WeightRange) -> Self {
        FilterWeight::Range(range)
    }
}