rustici 1.1.1

Pure-Rust client for strongSwan's VICI protocol
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

//! Packet layer definitions (outside the message codec).

use crate::wire::Message;
use std::fmt;

/// Top-level packet types in the VICI protocol.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum PacketType {
    /// A named request message (client -> server).
    CmdRequest = 0,
    /// An unnamed response message (server -> client).
    CmdResponse = 1,
    /// An unnamed response indicating the command was unknown.
    CmdUnknown = 2,
    /// A named event registration request (client -> server).
    EventRegister = 3,
    /// A named event deregistration request (client -> server).
    EventUnregister = 4,
    /// An unnamed response for successful event (de-)registration.
    EventConfirm = 5,
    /// An unnamed response if event (de-)registration failed.
    EventUnknown = 6,
    /// A named event message (server -> client).
    Event = 7,
}

impl PacketType {
    /// Whether this packet carries a "name" field (single-byte length + ASCII bytes).
    pub fn is_named(self) -> bool {
        matches!(
            self,
            PacketType::CmdRequest
                | PacketType::EventRegister
                | PacketType::EventUnregister
                | PacketType::Event
        )
    }
}

impl fmt::Display for PacketType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{self:?}")
    }
}

/// A parsed packet ready to be consumed by the application.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Packet {
    /// The packet type.
    pub ty: PacketType,
    /// Optional name (command name or event name), present if `ty.is_named()`.
    pub name: Option<String>,
    /// Optional hierarchical message.
    pub message: Option<Message>,
}

impl Packet {
    /// Create a new packet with optional name/message.
    pub fn new(ty: PacketType, name: Option<String>, message: Option<Message>) -> Self {
        Self { ty, name, message }
    }
}