mdf4-rs 0.6.0

mdf4-rs is a Rust library for working with Measurement Data Format (ASAM MDF4) files.
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

use crate::{
    Result,
    blocks::{
        read_string_block, {SourceBlock, read_source_block},
    },
};

/// Ergonomic view of an SIBLOCK: human‐readable source name, path, comment.
#[derive(Debug)]
pub struct SourceInfo {
    /// The “source name” (si_tx_name)
    pub name: Option<String>,
    /// The “source path” (si_tx_path)
    pub path: Option<String>,
    /// Any extended comment/XML (si_md_comment)
    pub comment: Option<String>,
}

impl SourceInfo {
    /// Parse a source information block from the memory mapped file.
    ///
    /// # Arguments
    /// * `mmap` - The memory mapped MDF file
    /// * `address` - File offset of the SIBLOCK (0 if not present)
    ///
    /// # Returns
    /// `Ok(Some(SourceInfo))` if a block was found, `Ok(None)` if the address
    /// was zero, or an [`crate::Error`] when parsing fails.
    pub fn from_mmap(mmap: &[u8], address: u64) -> Result<Option<Self>> {
        // 0 means “no SIBLOCK”
        if address == 0 {
            return Ok(None);
        }
        // read the raw block first
        let sb: SourceBlock = read_source_block(mmap, address)?;
        // now read each link as a String (may return None if addr == 0)
        let name: Option<String> = read_string_block(mmap, sb.name_addr)?;
        let path: Option<String> = read_string_block(mmap, sb.path_addr)?;
        let comment: Option<String> = read_string_block(mmap, sb.comment_addr)?;
        Ok(Some(SourceInfo {
            name,
            path,
            comment,
        }))
    }
}