Skip to main content

Crate mdflib

Crate mdflib 

Source
Expand description

§mdflib

Safe Rust bindings for the mdflib C++ library. mdflib is a library for reading and writing MDF (Measurement Data Format) files. This crate provides a high-level API that wraps the C++ library in safe Rust code.

§Features

  • Read and write MDF files (versions 3.x and 4.x).
  • Access to file metadata and channel information.
  • Read and write channel data.
  • bundled (default): Compiles and statically links the mdflib C++ library.
  • system: Links against a system-installed version of mdflib.

See crate::MdfReader and crate::MdfWriter docs for examples of how to use the library. The ‘examples/read_mdf.rs’ and workspace binary ‘mf4_candump’ provide additional usage examples.

Re-exports§

pub use canmessage::CanMessage;
pub use canmessage::CanMessageRef;
pub use channel::Channel;
pub use channel::ChannelRef;
pub use channelgroup::ChannelGroup;
pub use channelgroup::ChannelGroupRef;
pub use datagroup::DataGroup;
pub use datagroup::DataGroupRef;
pub use error::MdfError;
pub use error::Result;
pub use file::MdfFile;
pub use file::MdfFileRef;
pub use header::MdfHeader;
pub use header::MdfHeaderRef;
pub use reader::MdfReader;
pub use writer::MdfWriter;
pub use attachment::Attachment;
pub use attachment::AttachmentRef;
pub use canbusobserver::create_can_bus_observer;
pub use canbusobserver::CanBusObserver;
pub use canbusobserver::CanBusObserverRef;
pub use channelarray::ChannelArray;
pub use channelarray::ChannelArrayRef;
pub use channelconversion::ChannelConversion;
pub use channelconversion::ChannelConversionRef;
pub use channelobserver::create_channel_observer;
pub use channelobserver::ChannelObserver;
pub use channelobserver::ChannelObserverRef;
pub use etag::ETag;
pub use etag::ETagRef;
pub use event::Event;
pub use event::EventRef;
pub use filehistory::FileHistory;
pub use filehistory::FileHistoryRef;
pub use log::log_callback;
pub use log::set_log_callback_1;
pub use metadata::MetaData;
pub use metadata::MetaDataRef;
pub use sourceinformation::SourceInformation;
pub use sourceinformation::SourceInformationRef;

Modules§

attachment
Attachment wrapper for mdflib
canbusobserver
CanBusObserver wrapper for mdflib CanBusObserver
canmessage
CAN message wrapper for mdflib CanMessage
channel
Channel wrapper for mdflib IChannel
channelarray
ChannelArray wrapper for mdflib IChannelArray
channelconversion
ChannelConversion wrapper for mdflib IChannelConversion
channelgroup
ChannelGroup wrapper for mdflib IChannelGroup
channelobserver
ChannelObserver wrapper for mdflib IChannelObserver
datagroup
DataGroup wrapper for mdflib IDataGroup
error
Error types for mdflib operations
etag
ETag wrapper for mdflib IETag
event
Event wrapper for mdflib IEvent
file
MDF file wrapper for mdflib MdfFile
filehistory
FileHistory wrapper for mdflib IFileHistory
header
Header wrapper for mdflib IHeader
log
Logging functionality for the mdflib crate.
metadata
MetaData wrapper for mdflib IMetaData
reader
MDF file reader implementation
sourceinformation
SourceInformation wrapper for mdflib ISourceInformation
writer
MDF file writer implementation provides a safe wrapper around the mdflib C++ library’s MdfWriter. It allows for creating and writing data to MDF files.

Enums§

ArrayStorage
\brief Type of storage.
ArrayType
\brief Type of array.
BusType
\brief Type of bus.
CanErrorType
ChannelType
\brief Channel functional type.
ConversionType
\brief Type of conversion formula
ETagDataType
\brief The e-tag may optional have a data type below. The value in the XML file is of course string but the data type may be used for interpretation of the value. Note that unit property can also be added.
EventCause
\brief Type of cause.
EventType
\brief Type of event.
MdfBusType
\brief Enumerate that defines type of bus. Only relevant for bus logging.
MdfWriterType
MessageType
RangeType
\brief Type of range.
SourceType
\brief Type of source information.
SyncType
\brief Type of synchronization value (default time)