rs-matter 0.2.0

Native Rust implementation of the Matter (Smart-Home) ecosystem
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

/*
 *
 *    Copyright (c) 2025-2026 Project CHIP Authors
 *
 *    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.
 */

//! This module defines the `Status` and `StatusResp` structures used in the Interaction Model.

use crate::error::Error;
use crate::tlv::{FromTLV, TagType, ToTLV};
use crate::utils::storage::WriteBuf;

use super::{IMStatusCode, IM_REVISION};

/// An IM status structure that contains an `IMStatusCode` and an optional cluster status code.
///
/// Corresponds to the `StatusIB` block in the Matter Interaction Model.
#[derive(Debug, Clone, PartialEq, Eq, Hash, FromTLV, ToTLV)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct Status {
    /// The status code of the IM operation.
    pub status: IMStatusCode,
    /// An optional cluster status code, which is used for cluster-specific status codes.
    pub cluster_status: Option<u16>,
}

impl Status {
    /// Create a new `Status` instance with the given `IMStatusCode` and an optional cluster status code.
    pub const fn new(status: IMStatusCode, cluster_status: Option<u16>) -> Status {
        Status {
            status,
            cluster_status,
        }
    }
}

/// An IM status response structure used for sending/receiving status responses in the Interaction Model.
///
/// Corresponds to the `StatusResponseMessage` struct in the Matter Interaction Model.
#[derive(Debug, Clone, PartialEq, Eq, Hash, FromTLV, ToTLV)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct StatusResp {
    pub status: IMStatusCode,
    /// `interactionModelRevision` — mandatory in every IM message we send;
    /// modelled as `Option<u8>` so we tolerate peers that omit it (the C++
    /// SDK is tolerant in practice).
    #[tagval(crate::im::encoding::IM_REVISION_TAG)]
    pub interaction_model_revision: Option<u8>,
}

// Custom `Default` (rather than derived) so the trailing
// `interaction_model_revision` defaults to `Some(IM_REVISION)` instead of
// `None` — that way struct-literal fallbacks like
// `StatusResp { status, ..Default::default() }` produce a spec-compliant
// on-the-wire response without each caller setting it.
impl Default for StatusResp {
    fn default() -> Self {
        Self {
            status: IMStatusCode::Success,
            interaction_model_revision: Some(IM_REVISION),
        }
    }
}

impl StatusResp {
    pub fn write(wb: &mut WriteBuf, status: IMStatusCode) -> Result<(), Error> {
        Self {
            status,
            ..Default::default()
        }
        .to_tlv(&TagType::Anonymous, &mut *wb)
    }
}