mirage-block-lwt

Utilities and module definitions for dealing with block devices
README

This repo contains generic operations over Mirage BLOCK devices.

Please consult the API documentation.

Example usage

In a top-level like utop:

# #require "io-page.unix";;
# #require "mirage-block";;
# #require "mirage-block-ramdisk";;
# #require "lwt.syntax";;

# lwt t_or_error = Ramdisk.create ~name:"hello" ~size_sectors:1024L ~sector_size:512;;
val t_or_error : [ `Error of Ramdisk.error | `Ok of Ramdisk.t ] = `Ok <abstr>

# let t = Mirage_block.Error.ok_exn t_or_error;;
val t : Ramdisk.t = <abstr>

# let page = Io_page.(to_cstruct (get 1));;
val page : Ramdisk.page_aligned_buffer =
  {Cstruct.buffer = <abstr>; off = 0; len = 4096}

# lwt result_or_error = Ramdisk.read t 0L [ page ];;
val result_or_error : [ `Error of Ramdisk.error | `Ok of unit ] = `Ok ()

# lwt ok_or_error = Mirage_block.sparse_copy (module Ramdisk) t (module Ramdisk) t;;
val ok_or_error :
  [ `Error of [> `Different_sizes | `Is_read_only | `Msg of bytes ]
  | `Ok of unit ] = `Ok ()
Install
Published
22 May 2017
Maintainers
Sources
mirage-block-1.1.0.tbz
md5=e0ecf9f8ec64a70e4b514f477c6e7634
Dependencies
result
< "1.5"
mirage-block
>= "1.0.0" & < "2.0.0"
lwt
>= "2.4.7"
cstruct
>= "2.0.0" & < "6.0.1"
jbuilder
>= "1.0+beta9"
ocaml
>= "4.02.0"
Reverse Dependencies
fat-filesystem
>= "0.12.0" & < "0.14.0"
mirage-block-ramdisk
>= "0.3" & < "0.5"
mirage-block-solo5
>= "0.2.1" & < "0.6.1"
mirage-block-unix
>= "2.5.0" & < "2.12.0"
mirage-block-xen
>= "1.5.0" & < "1.7.0"
mirage-types-lwt
>= "3.0.0" & < "3.7.1"
nbd
>= "3.0.0"
qcow
>= "0.8.1" & < "0.11.0"
qcow-tool
< "0.11.0"
tar-mirage
= "1.1.0"