spodes-rs 0.7.1

A pure-Rust DLMS/COSEM stack: interface classes, transport, xDLMS services and security (IEC 62056 and the СТО 34.01-5.1-006-2023 / Р 1323565.1 GOST profiles).
Documentation
use crate::interface::InterfaceClass;
use crate::obis::ObisCode;
use crate::types::attrs::SpecialDayEntry;
use crate::types::{BerError, CosemDataType};
use serde::{Deserialize, Serialize};
use std::any::Any;

/// Configuration used to build a `SpecialDaysTable` object.
#[derive(Clone, Serialize, Deserialize, Debug)]
pub struct SpecialDaysTableConfig {
    /// Attribute 1: the object's logical name (OBIS code).
    pub logical_name: ObisCode,
    /// Attribute 2: array of `special_day` entries { index, date, day_id }.
    pub entries: Vec<SpecialDayEntry>,
}

/// The `SpecialDaysTable` interface class (class_id = 11, version = 0) managing a
/// list of special days, per IEC 62056-6-2:2019.
#[derive(Clone, Serialize, Deserialize, Debug)]
pub struct SpecialDaysTable {
    logical_name: ObisCode,
    entries: Vec<SpecialDayEntry>,
}

impl SpecialDaysTable {
    /// Builds a new [`SpecialDaysTable`] from its configuration.
    pub fn new(config: SpecialDaysTableConfig) -> Self {
        SpecialDaysTable { logical_name: config.logical_name, entries: config.entries }
    }

    fn insert(&mut self, data: &CosemDataType) -> Result<CosemDataType, String> {
        let entry = SpecialDayEntry::try_from(data)?;
        if entry.specialday_date.len() != 12 {
            return Err("Invalid DateTime length".to_string());
        }
        self.entries.push(entry);
        Ok(CosemDataType::Null)
    }

    fn delete(&mut self, data: &CosemDataType) -> Result<CosemDataType, String> {
        let entry = SpecialDayEntry::try_from(data)?;
        self.entries.retain(|e| e.index != entry.index);
        Ok(CosemDataType::Null)
    }
}

impl InterfaceClass for SpecialDaysTable {
    fn class_id(&self) -> u16 {
        11
    }

    fn version(&self) -> u8 {
        0
    }

    fn logical_name(&self) -> &ObisCode {
        &self.logical_name
    }

    fn attributes(&self) -> Vec<(u8, CosemDataType)> {
        vec![
            (1, CosemDataType::OctetString(self.logical_name.to_bytes())),
            (2, CosemDataType::Array(self.entries.iter().cloned().map(Into::into).collect())),
        ]
    }

    fn methods(&self) -> Vec<(u8, String)> {
        vec![(1, "insert".to_string()), (2, "delete".to_string())]
    }

    fn serialize_ber(&self, buf: &mut Vec<u8>) -> Result<(), BerError> {
        let mut seq_buf = Vec::new();
        CosemDataType::LongUnsigned(self.class_id()).serialize_ber(&mut seq_buf)?;
        for (_, attr) in self.attributes() {
            attr.serialize_ber(&mut seq_buf)?;
        }
        buf.push(0x02); // structure [2]
        write_length(1 + self.attributes().len(), buf); // length = element count
        buf.extend_from_slice(&seq_buf);
        Ok(())
    }

    fn deserialize_ber(&mut self, data: &[u8]) -> Result<(), BerError> {
        let (tlv, rest) = CosemDataType::deserialize_ber(data)?;
        if !rest.is_empty() {
            return Err(BerError::InvalidTag);
        }
        let CosemDataType::Structure(seq) = tlv else {
            return Err(BerError::InvalidTag);
        };
        if seq.len() == 3 {
            if let CosemDataType::LongUnsigned(class_id) = seq[0] {
                if class_id != self.class_id() {
                    return Err(BerError::InvalidValue);
                }
            } else {
                return Err(BerError::InvalidTag);
            }
            if let CosemDataType::OctetString(obis) = &seq[1] {
                if obis.len() == 6 {
                    self.logical_name = ObisCode::new(obis[0], obis[1], obis[2], obis[3], obis[4], obis[5]);
                } else {
                    return Err(BerError::InvalidLength);
                }
            } else {
                return Err(BerError::InvalidTag);
            }
            if let CosemDataType::Array(entries) = &seq[2] {
                let mut parsed = Vec::new();
                for entry in entries {
                    let special_entry = SpecialDayEntry::try_from(entry).map_err(|_| BerError::InvalidValue)?;
                    if special_entry.specialday_date.len() != 12 {
                        return Err(BerError::InvalidLength);
                    }
                    parsed.push(special_entry);
                }
                self.entries = parsed;
            } else {
                return Err(BerError::InvalidTag);
            }
            Ok(())
        } else {
            Err(BerError::InvalidLength)
        }
    }

    fn set_attribute(&mut self, attribute_id: u8, value: CosemDataType) -> Result<(), String> {
        match attribute_id {
            2 => {
                let CosemDataType::Array(entries) = value else {
                    return Err("entries must be array".into());
                };
                self.entries = entries.iter().map(SpecialDayEntry::try_from).collect::<Result<Vec<_>, _>>()?;
                Ok(())
            }
            _ => Err(format!("SpecialDaysTable attribute {attribute_id} is not writable")),
        }
    }

    fn invoke_method(&mut self, method_id: u8, params: Option<CosemDataType>) -> Result<CosemDataType, String> {
        match method_id {
            1 => self.insert(&params.ok_or("Missing parameter for insert method")?),
            2 => self.delete(&params.ok_or("Missing parameter for delete method")?),
            _ => Err(format!("Method {method_id} not supported for SpecialDaysTable")),
        }
    }

    fn as_any(&self) -> &dyn Any {
        self
    }
}

/// Writes a BER/A-XDR length octet (short or long form).
#[allow(clippy::cast_possible_truncation)] // length < 128 and num_octets in 1..=8 always fit u8
fn write_length(length: usize, buf: &mut Vec<u8>) {
    if length < 128 {
        buf.push(length as u8);
    } else {
        let bytes = (length as u64).to_be_bytes();
        let first_non_zero = bytes.iter().position(|&b| b != 0).unwrap_or(7);
        let num_octets = 8 - first_non_zero;
        buf.push(0x80 | num_octets as u8);
        buf.extend_from_slice(&bytes[first_non_zero..]);
    }
}