matter-clusters 0.3.0

//! Groups cluster (0x0004).
//! @generated by `cargo xtask codegen` — do not edit.

#![allow(
    clippy::all,
    clippy::pedantic,
    dead_code,
    unreachable_pub,
    unused_imports
)]

use crate::datatypes::SemanticTagStruct;
use crate::error::ClusterError;
use crate::types::Nullable;
use matter_codec::{ContainerKind, Element, Tag, TlvReader, TlvWriter, Value};

/// Cluster ID.
pub const CLUSTER_ID: u32 = 0x0004;
/// Cluster revision.
pub const CLUSTER_REVISION: u16 = 4;

/// Command IDs (requests and responses).
pub mod command_id {
    /// `AddGroup` (request).
    pub const ADD_GROUP: u32 = 0x00;
    /// `AddGroupResponse` (response).
    pub const ADD_GROUP_RESPONSE: u32 = 0x00;
    /// `ViewGroup` (request).
    pub const VIEW_GROUP: u32 = 0x01;
    /// `ViewGroupResponse` (response).
    pub const VIEW_GROUP_RESPONSE: u32 = 0x01;
    /// `GetGroupMembership` (request).
    pub const GET_GROUP_MEMBERSHIP: u32 = 0x02;
    /// `GetGroupMembershipResponse` (response).
    pub const GET_GROUP_MEMBERSHIP_RESPONSE: u32 = 0x02;
    /// `RemoveGroup` (request).
    pub const REMOVE_GROUP: u32 = 0x03;
    /// `RemoveGroupResponse` (response).
    pub const REMOVE_GROUP_RESPONSE: u32 = 0x03;
    /// `RemoveAllGroups` (request).
    pub const REMOVE_ALL_GROUPS: u32 = 0x04;
    /// `AddGroupIfIdentifying` (request).
    pub const ADD_GROUP_IF_IDENTIFYING: u32 = 0x05;
}

/// Attribute IDs (cluster-specific).
pub mod attribute_id {
    /// `NameSupport`.
    pub const NAME_SUPPORT: u32 = 0x0000;
}

bitflags::bitflags! {
    /// `Groups` feature bits (FeatureMap).
    #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
    pub struct Feature: u32 {
        /// GroupNames (GN).
        const GN = 1 << 0;
    }
}

bitflags::bitflags! {
    /// `NameSupportBitmap` (map8).
    #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
    pub struct NameSupportBitmap: u8 {
        /// GroupNames.
        const GROUP_NAMES = 1 << 7;
    }
}

/// Decode the `NameSupport` attribute value.
///
/// # Errors
/// Returns [`ClusterError`] on a type mismatch or out-of-range value.
pub fn decode_name_support(tlv: &[u8]) -> Result<NameSupportBitmap, ClusterError> {
    let mut r = TlvReader::new(tlv);
    match r.next()? {
        Some(Element::Scalar {
            value: Value::Uint(v),
            ..
        }) => Ok(NameSupportBitmap::from_bits_retain(
            u8::try_from(v).map_err(|_| ClusterError::InvalidLength("NameSupport"))?,
        )),
        _ => Err(ClusterError::UnexpectedType {
            context: "NameSupport",
        }),
    }
}

/// Encode the `AddGroup` command request payload.
#[must_use]
#[allow(clippy::expect_used, clippy::missing_panics_doc)] // Vec-backed TlvWriter is infallible.
pub fn encode_add_group(group_id: u16, group_name: &String) -> Vec<u8> {
    let mut buf = Vec::new();
    let mut w = TlvWriter::new(&mut buf);
    w.start_structure(Tag::Anonymous)
        .expect("infallible: vec writer");
    w.put_uint(Tag::Context(0), u64::from(group_id))
        .expect("infallible: vec writer");
    w.put_utf8(Tag::Context(1), &group_name)
        .expect("infallible: vec writer");
    w.end_container().expect("infallible: vec writer");
    buf
}

/// Decoded `AddGroupResponse` payload.
#[derive(Clone, Debug, PartialEq)]
#[non_exhaustive]
pub struct AddGroupResponse {
    /// Field Status (tag 0).
    pub status: u8,
    /// Field GroupId (tag 1).
    pub group_id: u16,
}

impl AddGroupResponse {
    /// Decode the fields of an already-opened anonymous structure
    /// (reader positioned after the struct start; consumes to its end).
    ///
    /// # Errors
    /// Returns [`ClusterError`] on a malformed structure or missing required field.
    pub fn decode_from(r: &mut TlvReader<'_>) -> Result<Self, ClusterError> {
        let mut f_status: Option<u8> = None;
        let mut f_group_id: Option<u16> = None;
        loop {
            match r.next()? {
                Some(Element::ContainerEnd) => break,
                Some(Element::Scalar {
                    tag: Tag::Context(0),
                    value: Value::Uint(v),
                }) => {
                    f_status =
                        Some(u8::try_from(v).map_err(|_| ClusterError::InvalidLength("Status"))?)
                }
                Some(Element::Scalar {
                    tag: Tag::Context(1),
                    value: Value::Uint(v),
                }) => {
                    f_group_id =
                        Some(u16::try_from(v).map_err(|_| ClusterError::InvalidLength("GroupId"))?)
                }
                None => return Err(ClusterError::Tlv(matter_codec::Error::UnclosedContainer)),
                Some(Element::ContainerStart { .. }) => r.skip_container()?,
                Some(_) => {} // unknown/future scalar — skip
            }
        }
        Ok(Self {
            status: f_status.ok_or(ClusterError::MissingField("Status"))?,
            group_id: f_group_id.ok_or(ClusterError::MissingField("GroupId"))?,
        })
    }
    /// Decode from a standalone anonymous TLV structure.
    ///
    /// # Errors
    /// Returns [`ClusterError`] if the bytes are not an anonymous structure or a field is malformed.
    pub fn decode(tlv: &[u8]) -> Result<Self, ClusterError> {
        let mut r = TlvReader::new(tlv);
        match r.next()? {
            Some(Element::ContainerStart {
                kind: ContainerKind::Structure,
                ..
            }) => {}
            _ => {
                return Err(ClusterError::UnexpectedType {
                    context: "AddGroupResponse",
                })
            }
        }
        Self::decode_from(&mut r)
    }
}

/// Encode the `ViewGroup` command request payload.
#[must_use]
#[allow(clippy::expect_used, clippy::missing_panics_doc)] // Vec-backed TlvWriter is infallible.
pub fn encode_view_group(group_id: u16) -> Vec<u8> {
    let mut buf = Vec::new();
    let mut w = TlvWriter::new(&mut buf);
    w.start_structure(Tag::Anonymous)
        .expect("infallible: vec writer");
    w.put_uint(Tag::Context(0), u64::from(group_id))
        .expect("infallible: vec writer");
    w.end_container().expect("infallible: vec writer");
    buf
}

/// Decoded `ViewGroupResponse` payload.
#[derive(Clone, Debug, PartialEq)]
#[non_exhaustive]
pub struct ViewGroupResponse {
    /// Field Status (tag 0).
    pub status: u8,
    /// Field GroupId (tag 1).
    pub group_id: u16,
    /// Field GroupName (tag 2).
    pub group_name: String,
}

impl ViewGroupResponse {
    /// Decode the fields of an already-opened anonymous structure
    /// (reader positioned after the struct start; consumes to its end).
    ///
    /// # Errors
    /// Returns [`ClusterError`] on a malformed structure or missing required field.
    pub fn decode_from(r: &mut TlvReader<'_>) -> Result<Self, ClusterError> {
        let mut f_status: Option<u8> = None;
        let mut f_group_id: Option<u16> = None;
        let mut f_group_name: Option<String> = None;
        loop {
            match r.next()? {
                Some(Element::ContainerEnd) => break,
                Some(Element::Scalar {
                    tag: Tag::Context(0),
                    value: Value::Uint(v),
                }) => {
                    f_status =
                        Some(u8::try_from(v).map_err(|_| ClusterError::InvalidLength("Status"))?)
                }
                Some(Element::Scalar {
                    tag: Tag::Context(1),
                    value: Value::Uint(v),
                }) => {
                    f_group_id =
                        Some(u16::try_from(v).map_err(|_| ClusterError::InvalidLength("GroupId"))?)
                }
                Some(Element::Scalar {
                    tag: Tag::Context(2),
                    value: Value::Utf8(v),
                }) => f_group_name = Some(v),
                None => return Err(ClusterError::Tlv(matter_codec::Error::UnclosedContainer)),
                Some(Element::ContainerStart { .. }) => r.skip_container()?,
                Some(_) => {} // unknown/future scalar — skip
            }
        }
        Ok(Self {
            status: f_status.ok_or(ClusterError::MissingField("Status"))?,
            group_id: f_group_id.ok_or(ClusterError::MissingField("GroupId"))?,
            group_name: f_group_name.ok_or(ClusterError::MissingField("GroupName"))?,
        })
    }
    /// Decode from a standalone anonymous TLV structure.
    ///
    /// # Errors
    /// Returns [`ClusterError`] if the bytes are not an anonymous structure or a field is malformed.
    pub fn decode(tlv: &[u8]) -> Result<Self, ClusterError> {
        let mut r = TlvReader::new(tlv);
        match r.next()? {
            Some(Element::ContainerStart {
                kind: ContainerKind::Structure,
                ..
            }) => {}
            _ => {
                return Err(ClusterError::UnexpectedType {
                    context: "ViewGroupResponse",
                })
            }
        }
        Self::decode_from(&mut r)
    }
}

/// Encode the `GetGroupMembership` command request payload.
#[must_use]
#[allow(clippy::expect_used, clippy::missing_panics_doc)] // Vec-backed TlvWriter is infallible.
pub fn encode_get_group_membership(group_list: &Vec<u16>) -> Vec<u8> {
    let mut buf = Vec::new();
    let mut w = TlvWriter::new(&mut buf);
    w.start_structure(Tag::Anonymous)
        .expect("infallible: vec writer");
    w.start_array(Tag::Context(0))
        .expect("infallible: vec writer");
    for el in group_list.iter().copied() {
        w.put_uint(Tag::Anonymous, u64::from(el))
            .expect("infallible: vec writer");
    }
    w.end_container().expect("infallible: vec writer");
    w.end_container().expect("infallible: vec writer");
    buf
}

/// Decoded `GetGroupMembershipResponse` payload.
#[derive(Clone, Debug, PartialEq)]
#[non_exhaustive]
pub struct GetGroupMembershipResponse {
    /// Field Capacity (tag 0).
    pub capacity: Nullable<u8>,
    /// Field GroupList (tag 1).
    pub group_list: Vec<u16>,
}

impl GetGroupMembershipResponse {
    /// Decode the fields of an already-opened anonymous structure
    /// (reader positioned after the struct start; consumes to its end).
    ///
    /// # Errors
    /// Returns [`ClusterError`] on a malformed structure or missing required field.
    pub fn decode_from(r: &mut TlvReader<'_>) -> Result<Self, ClusterError> {
        let mut f_capacity: Option<Nullable<u8>> = None;
        let mut f_group_list: Option<Vec<u16>> = None;
        loop {
            match r.next()? {
                Some(Element::ContainerEnd) => break,
                Some(Element::Scalar {
                    tag: Tag::Context(0),
                    value: Value::Null,
                }) => f_capacity = Some(Nullable::Null),
                Some(Element::Scalar {
                    tag: Tag::Context(0),
                    value: Value::Uint(v),
                }) => {
                    f_capacity = Some(Nullable::Value(
                        u8::try_from(v).map_err(|_| ClusterError::InvalidLength("Capacity"))?,
                    ))
                }
                Some(Element::ContainerStart {
                    tag: Tag::Context(1),
                    kind: ContainerKind::Array,
                }) => {
                    let mut out = Vec::new();
                    loop {
                        match r.next()? {
                            Some(Element::ContainerEnd) => break,
                            Some(Element::Scalar {
                                value: Value::Uint(v),
                                ..
                            }) => out.push(
                                u16::try_from(v)
                                    .map_err(|_| ClusterError::InvalidLength("GroupList"))?,
                            ),
                            None => {
                                return Err(ClusterError::Tlv(
                                    matter_codec::Error::UnclosedContainer,
                                ))
                            }
                            Some(Element::ContainerStart { .. }) => r.skip_container()?,
                            Some(_) => {} // skip unknown scalar
                        }
                    }
                    f_group_list = Some(out);
                }
                None => return Err(ClusterError::Tlv(matter_codec::Error::UnclosedContainer)),
                Some(Element::ContainerStart { .. }) => r.skip_container()?,
                Some(_) => {} // unknown/future scalar — skip
            }
        }
        Ok(Self {
            capacity: f_capacity.ok_or(ClusterError::MissingField("Capacity"))?,
            group_list: f_group_list.ok_or(ClusterError::MissingField("GroupList"))?,
        })
    }
    /// Decode from a standalone anonymous TLV structure.
    ///
    /// # Errors
    /// Returns [`ClusterError`] if the bytes are not an anonymous structure or a field is malformed.
    pub fn decode(tlv: &[u8]) -> Result<Self, ClusterError> {
        let mut r = TlvReader::new(tlv);
        match r.next()? {
            Some(Element::ContainerStart {
                kind: ContainerKind::Structure,
                ..
            }) => {}
            _ => {
                return Err(ClusterError::UnexpectedType {
                    context: "GetGroupMembershipResponse",
                })
            }
        }
        Self::decode_from(&mut r)
    }
}

/// Encode the `RemoveGroup` command request payload.
#[must_use]
#[allow(clippy::expect_used, clippy::missing_panics_doc)] // Vec-backed TlvWriter is infallible.
pub fn encode_remove_group(group_id: u16) -> Vec<u8> {
    let mut buf = Vec::new();
    let mut w = TlvWriter::new(&mut buf);
    w.start_structure(Tag::Anonymous)
        .expect("infallible: vec writer");
    w.put_uint(Tag::Context(0), u64::from(group_id))
        .expect("infallible: vec writer");
    w.end_container().expect("infallible: vec writer");
    buf
}

/// Decoded `RemoveGroupResponse` payload.
#[derive(Clone, Debug, PartialEq)]
#[non_exhaustive]
pub struct RemoveGroupResponse {
    /// Field Status (tag 0).
    pub status: u8,
    /// Field GroupId (tag 1).
    pub group_id: u16,
}

impl RemoveGroupResponse {
    /// Decode the fields of an already-opened anonymous structure
    /// (reader positioned after the struct start; consumes to its end).
    ///
    /// # Errors
    /// Returns [`ClusterError`] on a malformed structure or missing required field.
    pub fn decode_from(r: &mut TlvReader<'_>) -> Result<Self, ClusterError> {
        let mut f_status: Option<u8> = None;
        let mut f_group_id: Option<u16> = None;
        loop {
            match r.next()? {
                Some(Element::ContainerEnd) => break,
                Some(Element::Scalar {
                    tag: Tag::Context(0),
                    value: Value::Uint(v),
                }) => {
                    f_status =
                        Some(u8::try_from(v).map_err(|_| ClusterError::InvalidLength("Status"))?)
                }
                Some(Element::Scalar {
                    tag: Tag::Context(1),
                    value: Value::Uint(v),
                }) => {
                    f_group_id =
                        Some(u16::try_from(v).map_err(|_| ClusterError::InvalidLength("GroupId"))?)
                }
                None => return Err(ClusterError::Tlv(matter_codec::Error::UnclosedContainer)),
                Some(Element::ContainerStart { .. }) => r.skip_container()?,
                Some(_) => {} // unknown/future scalar — skip
            }
        }
        Ok(Self {
            status: f_status.ok_or(ClusterError::MissingField("Status"))?,
            group_id: f_group_id.ok_or(ClusterError::MissingField("GroupId"))?,
        })
    }
    /// Decode from a standalone anonymous TLV structure.
    ///
    /// # Errors
    /// Returns [`ClusterError`] if the bytes are not an anonymous structure or a field is malformed.
    pub fn decode(tlv: &[u8]) -> Result<Self, ClusterError> {
        let mut r = TlvReader::new(tlv);
        match r.next()? {
            Some(Element::ContainerStart {
                kind: ContainerKind::Structure,
                ..
            }) => {}
            _ => {
                return Err(ClusterError::UnexpectedType {
                    context: "RemoveGroupResponse",
                })
            }
        }
        Self::decode_from(&mut r)
    }
}

/// Encode the `RemoveAllGroups` command request payload.
#[must_use]
#[allow(clippy::expect_used, clippy::missing_panics_doc)] // Vec-backed TlvWriter is infallible.
pub fn encode_remove_all_groups() -> Vec<u8> {
    let mut buf = Vec::new();
    let mut w = TlvWriter::new(&mut buf);
    w.start_structure(Tag::Anonymous)
        .expect("infallible: vec writer");
    w.end_container().expect("infallible: vec writer");
    buf
}

/// Encode the `AddGroupIfIdentifying` command request payload.
#[must_use]
#[allow(clippy::expect_used, clippy::missing_panics_doc)] // Vec-backed TlvWriter is infallible.
pub fn encode_add_group_if_identifying(group_id: u16, group_name: &String) -> Vec<u8> {
    let mut buf = Vec::new();
    let mut w = TlvWriter::new(&mut buf);
    w.start_structure(Tag::Anonymous)
        .expect("infallible: vec writer");
    w.put_uint(Tag::Context(0), u64::from(group_id))
        .expect("infallible: vec writer");
    w.put_utf8(Tag::Context(1), &group_name)
        .expect("infallible: vec writer");
    w.end_container().expect("infallible: vec writer");
    buf
}