coap-zero 0.3.0

CoAP protocol implementation for no_std without alloc
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

// Copyright Open Logistics Foundation
//
// Licensed under the Open Logistics Foundation License 1.3.
// For details on the licensing terms, see the LICENSE file.
// SPDX-License-Identifier: OLFL-1.3

use bondrewd::{BitfieldEnum, Bitfields};

use super::{
    codes::{Code, EncodedCode},
    token::TokenLength,
    Error, Type,
};

/// 4 byte Header of a CoAP Message
#[derive(Bitfields, Debug, PartialEq, Eq)]
#[bondrewd(enforce_bytes = 4)]
pub(crate) struct MessageHeader {
    #[bondrewd(bit_length = 2)]
    version: u8,
    #[bondrewd(bit_length = 2, enum_primitive = "u8")]
    message_type: Type,
    #[bondrewd(bit_length = 4)]
    token_length: u8,
    #[bondrewd(struct_size = 1)]
    code: EncodedCode,
    #[bondrewd(endianness = "big")]
    message_id: u16,
}

impl MessageHeader {
    /// Creates a new Message Header
    pub(crate) fn new(
        version: u8,
        message_type: Type,
        token_length: TokenLength,
        code: EncodedCode,
        message_id: u16,
    ) -> Self {
        Self {
            version,
            message_type,
            token_length: token_length as u8,
            code,
            message_id,
        }
    }

    /// CoAP Protocol Version
    pub(crate) fn version(&self) -> u8 {
        self.version
    }

    /// Type of the message
    pub(crate) fn message_type(&self) -> Type {
        self.message_type
    }

    /// Length of Token
    pub(crate) fn token_length(&self) -> Result<TokenLength, Error> {
        self.token_length.try_into()
    }

    /// Code of the message
    pub(crate) fn code(&self) -> Result<Code, Error> {
        self.code.try_into()
    }

    /// Id of the message
    pub(crate) fn message_id(&self) -> u16 {
        self.message_id
    }
}