Crate drmem_api

This crate is used by internal tasks of drmemd as well as hardware drivers.

The interfaces and types defined in this crate are useful for those wishing to write a new back-end storage module or a driver for the drmemd executable.

Modules

client

Defines types and interfaces that internal clients use to interact with the core of DrMem. The primary, internal client is the GraphQL interface, but asks in logic blocks also use this module.

device

Defines types related to devices.

driver

Defines types and interfaces that drivers use to interact with the core of DrMem.

Enums

Error

Enumerates all the errors that can be reported in DrMem. Authors for new drivers or storage backends should try to map their errors into one of these values. If no current value is appropriate, a new one could be added (requiring a new release of this crate) but make sure the new error code is generic enough that it may be useful for other drivers or backends. For instance, don’t add an error value that is specific to Redis. Add a more general value and use the associated description string to explain the details.

Traits

Store

Defines the trait that a back-end needs to implement to provide storage for – and access to – the state of each driver’s devices.

Type Aliases

Result

A specialization of std::result::Result<> where the error value is types::Error.