package qcow-stream

  1. Overview
  2. Docs
Library offering QCOW streaming capabilities

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (6)

Authors

  1. D
    David Scott

Maintainers

  1. D
    Dave Scott <dave@recoil.org>
  2. P
    Pau Ruiz Safont
  3. E
    Edwin Török

Sources

qcow-0.12.3.tbz
sha256=ebeaaab614d7c5350f3f5217525d4f34bf0859f7bdec22f1ea834b47fc6358dd
sha512=eb0c24333ca065c8511427cde7a23db886b83d9e3ff233702c006a713ad8c418a29a2a3746481d26053fea03f0a07ac93a57b966e547bf5dddf7b4e10ae731bd

doc/qcow-stream/Qcow_stream/index.html

Module Qcow_streamSource

Sourcemodule Header = Qcow_header
Sourcemodule Cache = Qcow_cache
Sourceexception Reference_outside_file of int64 * int64
Sourceval start_stream_decode : Lwt_unix.file_descr -> (int64 * int32 * int64 ref * int64 Qcow_types.Cluster.Map.t) Lwt.t

Decodes QCOW header and tables from the beginning of the stream, constructing a map of data clusters. Returns (virtual_size, cluster_bits, last_read_cluster, data_cluster_map)

Sourceval copy_data : progress_cb:(int -> unit) -> int64 ref -> int32 -> Lwt_unix.file_descr -> Lwt_unix.file_descr -> int64 Qcow_types.Cluster.Map.t -> unit Lwt.t

copy_data last_read_cluster cluster_bits input_fd output_fd data_cluster_map Copies data cluster-by-cluster concurrently

Sourceval stream_decode : ?progress_cb:(int -> unit) -> ?header_info:(int64 * int32 * int64 ref * int64 Qcow_types.Cluster.Map.t) -> Unix.file_descr -> string -> unit

stream_decode ?progress_cb ?header_info fd output_path decodes the input QCOW stream from fd, writing out the raw file to output_path.

Accepts header_info returned by start_stream_decode if the header has already been parsed separately (to determine the virtual size, for example).

If provided, progress_cb is a callback that will be called with integer percentage values representing copying progress.