package qcow

You can search for identifiers within the package.

in-package search v0.2.0

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
  - Map
- Qcow_int64
  - IntervalSet
    
    Interval
  - Map
- 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
    
    Map
  - Int
    
    IntervalSet
    
    Interval
    
    Map
  - Int16
  - Int32
  - Int64
    
    IntervalSet
    
    Interval
    
    Map
  - Int8
- Qcow_virtual
- Qcow_word_size
  - Cluster
    
    IntervalSet
    
    Interval
    
    Map

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

A physical address within the backing disk

include Ppx_sexp_conv_lib.Sexpable.S with type t := t

val t_of_sexp : Sexplib0.Sexp.t -> t

val sexp_of_t : t -> Sexplib0.Sexp.t

val is_compressed : t -> bool

True if the address has been marked as being compressed

val is_mutable : t -> bool

True if the offset is safe to mutate directly (i.e. is not referenced by a snapshot

val unmapped : t

An unmapped physical address

val shift : t -> int -> t

shift t bytes adds bytes to t, maintaining other properties

val make : ?is_mutable:bool -> ?is_compressed:bool -> int -> t

Create an address at the given byte offset. This defaults to is_mutable = true which meand there are no snapshots implying that directly writing to this offset is ok; and is_compressed = false.

val add : t -> int -> t

Add a byte offset to a physical address

val to_sector : sector_size:int -> t -> int64 * int

Return the sector on disk, plus a remainder within the sector

val sector : sector_size:int -> t -> int64

Return the sector on disk containing the address

val to_bytes : t -> int

Return the byte offset on disk

val cluster : cluster_bits:int -> t -> Qcow_types.Cluster.t

Return the cluster containing the address

val within_cluster : cluster_bits:int -> t -> int

Return the index within the cluster of the address

val read : Cstruct.t -> t

Read a t from the given buffer

val write : t -> Cstruct.t -> unit

Write t to the buffer

include Qcow_s.PRINTABLE with type t := t

val to_string : t -> string

Produce a pretty human-readable string from a value