sciparse 0.6.1

Zero-copy SCION packet parsing, serialization and control plane components
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

// Copyright 2026 Anapaya Systems
//
// 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.

//! Layout for one-hop paths between neighboring border routers in SCION.

use crate::{
    core::{
        debug::Annotations,
        layout::{Layout, macros::gen_bitrange_const},
        view::ViewConversionError,
    },
    dataplane_path::standard::layout::{HopFieldLayout, InfoFieldLayout},
};

/// Layout for a one-hop path between neighboring border routers in SCION.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct OneHopPathLayout;
impl OneHopPathLayout {
    // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    // |                           InfoField                           |
    // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    // |                           HopField                            |
    // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    // |                           HopField                            |
    // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

    /// Total size of a one-hop path in bytes
    pub const SIZE_BYTES: usize = InfoFieldLayout::SIZE_BYTES + 2 * HopFieldLayout::SIZE_BYTES;

    gen_bitrange_const!(INFO_FIELD, 0, InfoFieldLayout::SIZE_BYTES * 8);
    gen_bitrange_const!(
        HOP_FIELD_1,
        Self::INFO_FIELD.end,
        HopFieldLayout::SIZE_BYTES * 8
    );
    gen_bitrange_const!(
        HOP_FIELD_2,
        Self::HOP_FIELD_1.end,
        HopFieldLayout::SIZE_BYTES * 8
    );
    gen_bitrange_const!(TOTAL, 0, Self::SIZE_BYTES * 8);
}
impl OneHopPathLayout {
    /// Returns an array of all field layouts in the one-hop path layout.
    #[inline]
    pub fn annotations(&self) -> Annotations {
        let mut annotations = Annotations::new();
        annotations.extend(InfoFieldLayout.annotations());
        annotations.extend(HopFieldLayout.annotations());
        annotations.extend(HopFieldLayout.annotations());
        annotations
    }
}
impl Layout for OneHopPathLayout {
    #[inline]
    fn size_bytes(&self) -> usize {
        Self::SIZE_BYTES
    }
}
impl TryFrom<&[u8]> for OneHopPathLayout {
    type Error = ViewConversionError;
    #[inline]
    fn try_from(buf: &[u8]) -> Result<Self, Self::Error> {
        if buf.len() < Self::SIZE_BYTES {
            return Err(ViewConversionError::BufferTooSmall {
                at: "OneHopPath",
                required: Self::SIZE_BYTES,
                actual: buf.len(),
            });
        }

        Ok(Self)
    }
}