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::Script;
use crate::types::{BerError, CosemDataType};
use serde::{Deserialize, Serialize};
use std::any::Any;

/// Configuration used to build a `ScriptTable` object.
#[derive(Clone, Serialize, Deserialize, Debug)]
pub struct ScriptTableConfig {
    /// Attribute 1: the object's logical name (OBIS code).
    pub logical_name: ObisCode,
    /// Attribute 2: array of `script` structures { script_identifier, actions }.
    pub scripts: Vec<Script>,
}

/// The `ScriptTable` interface class (class_id = 9) managing scripts that
/// define actions in the metering system, per IEC 62056-6-2.
//
#[derive(Clone, Serialize, Deserialize, Debug)]
pub struct ScriptTable {
    logical_name: ObisCode,
    scripts: Vec<Script>,
}

impl ScriptTable {
    /// Creates a new `ScriptTable` object from its configuration.
    ///
    /// # Arguments
    /// * `config` - The configuration used to build the object.
    ///
    /// # Returns
    /// A new `ScriptTable`.
    pub fn new(config: ScriptTableConfig) -> Self {
        ScriptTable { logical_name: config.logical_name, scripts: config.scripts }
    }

    /// Executes the script with the given id.
    ///
    /// # Arguments
    /// * `params` - A `CosemDataType::LongUnsigned` (the script id).
    ///
    /// # Returns
    /// * `Ok(CosemDataType::Null)` - If the script was found and executed.
    /// * `Err(String)` - If the script was not found or the parameter is invalid.
    fn execute(&self, params: Option<&CosemDataType>) -> Result<CosemDataType, String> {
        if let Some(CosemDataType::LongUnsigned(script_id)) = params {
            for script in &self.scripts {
                if script.script_identifier == *script_id {
                    // The action execution logic would go here.
                    return Ok(CosemDataType::Null);
                }
            }
            return Err(format!("Script with ID {script_id} not found"));
        }
        Err("Invalid script ID parameter".to_string())
    }
}

impl InterfaceClass for ScriptTable {
    fn class_id(&self) -> u16 {
        9
    }

    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.scripts.iter().cloned().map(CosemDataType::from).collect())),
        ]
    }

    fn methods(&self) -> Vec<(u8, String)> {
        vec![(1, "execute".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);
        }
        if let CosemDataType::Structure(seq) = tlv {
            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(scripts) = &seq[2] {
                    self.scripts = scripts
                        .iter()
                        .map(Script::try_from)
                        .collect::<Result<Vec<_>, _>>()
                        .map_err(|_| BerError::InvalidValue)?;
                } else {
                    return Err(BerError::InvalidTag);
                }
                return Ok(());
            }
            return Err(BerError::InvalidLength);
        }
        Err(BerError::InvalidTag)
    }

    fn invoke_method(&mut self, method_id: u8, params: Option<CosemDataType>) -> Result<CosemDataType, String> {
        match method_id {
            1 => self.execute(params.as_ref()),
            _ => Err(format!("Method {method_id} not supported for ScriptTable class")),
        }
    }

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

/// Writes a length in BER (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..]);
    }
}