package mirage-block

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Block device signatures.

type error = [
  1. | `Disconnected
]

The type for IO operation errors.

val pp_error : error Fmt.t

pp_error pretty-prints errors.

type write_error = [
  1. | error
  2. | `Is_read_only
    (*

    attempted to write to a read-only disk

    *)
]
val pp_write_error : write_error Fmt.t

pp_write_error pretty-prints errors.

type info = {
  1. read_write : bool;
    (*

    True if we can write, false if read/only

    *)
  2. sector_size : int;
    (*

    Octets per sector

    *)
  3. size_sectors : int64;
    (*

    Total sectors per device

    *)
}

The type for characteristics of the block device. Note some devices may be able to make themselves bigger over time.

module type S = sig ... end

Operations on sector-addressible block devices, usually used for persistent storage.