package qcow-types

  1. Overview
  2. Docs
Minimal set of dependencies for qcow-stream, shared with qcow

Install 

dune-project
 Dependency

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

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-types/Qcow_physical/index.html

Module Qcow_physicalSource

Sourcetype t

A physical address within the backing disk

include Sexplib0.Sexpable.S with type t := t
Sourceval t_of_sexp : Sexplib0.Sexp.t -> t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval is_compressed : t -> bool

True if the address has been marked as being compressed

Sourceval is_mutable : t -> bool

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

Sourceval unmapped : t

An unmapped physical address

Sourceval shift : t -> int -> t

shift t bytes adds bytes to t, maintaining other properties

Sourceval 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.

Sourceval add : t -> int -> t

Add a byte offset to a physical address

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

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

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

Return the sector on disk containing the address

Sourceval to_bytes : t -> int

Return the byte offset on disk

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

Return the cluster containing the address

Sourceval within_cluster : cluster_bits:int -> t -> int

Return the index within the cluster of the address

Sourceval read : Cstruct.t -> t

Read a t from the given buffer

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

Write t to the buffer

include Qcow_s.PRINTABLE with type t := t
Sourceval to_string : t -> string

Produce a pretty human-readable string from a value