package qcow

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package qcow

qcow
- Qcow
  - Make
    
    B
    
    Config
    
    Debug
    
    Setting
    
    Stats
    
    Time
- Qcow_bitmap
  - Interval
  - Test
- Qcow_block_cache
  - Make
    
    B
- Qcow_cache
  - Debug
- Qcow_cluster_map
  - Available
  - Copies
  - Debug
  - Erased
  - Junk
  - Move
  - MutableSet
  - Roots
- Qcow_config
- Qcow_cstructs
  - BE
- Qcow_debug
- Qcow_diet
  - ELT
  - Make
    
    Elt
    
    Interval
  - Test
- Qcow_error
  - Lwt_error
    
    Infix
    
    List
  - Lwt_write_error
    
    Infix
- Qcow_header
- Qcow_int
  - IntervalSet
    
    Interval
- Qcow_int64
  - IntervalSet
    
    Interval
- Qcow_locks
  - Client
  - Debug
  - Read
  - Write
- Qcow_metadata
  - Physical
  - Refcounts
- Qcow_padded
  - Make
    
    B
- Qcow_physical
- Qcow_recycler
  - Make
    
    B
    
    Time
- Qcow_rwlock
  - Client
  - Debug
  - Read
  - Write
- Qcow_s
  - INTERVAL_SET
    
    Interval
  - LOG
  - NUM
  - PRINTABLE
  - RESIZABLE_BLOCK
  - SERIALISABLE
- Qcow_types
  - Cluster
    
    IntervalSet
    
    Interval
  - Int
    
    IntervalSet
    
    Interval
  - Int16
  - Int32
  - Int64
    
    IntervalSet
    
    Interval
  - Int8
- Qcow_virtual
- Qcow_word_size
  - Cluster
    
    IntervalSet
    
    Interval

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module B : Qcow_s.RESIZABLE_BLOCK

Signature

include Qcow_s.RESIZABLE_BLOCK

include Mirage_block_lwt.S

type page_aligned_buffer = Cstruct.t

type error = private [>

| Mirage_device.error

]

val pp_error : error Fmt.t

type write_error = private [>

| `Disconnected
| `Is_read_only
| `Unimplemented

]

val pp_write_error : write_error Fmt.t

type 'a io = 'a Lwt.t

type t

val disconnect : t -> unit io

val get_info : t -> Mirage_block.info io

val read : 
  t ->
  int64 ->
  page_aligned_buffer list ->
  (unit, error) Pervasives.result io

val write : 
  t ->
  int64 ->
  page_aligned_buffer list ->
  (unit, write_error) Pervasives.result io

val resize : t -> int64 -> (unit, write_error) Result.result Lwt.t

Resize the file to the given number of sectors.

val flush : t -> (unit, write_error) Result.result io

flush t flushes any buffers, if the file has been opened in buffered mode

val connect : ?max_size_bytes:int64 -> B.t -> t Lwt.t

connect ?max_size_bytes b constructs a cache over b with a maximum memory footprint of max_size_bytes. Writes are heavily cached and only written to disk on a flush, disconnect or when out of space.