package duff

You can search for identifiers within the package.

in-package search v0.2.0

package duff

duff
- Duff
  - Default
    
    Index
  - Delta
    
    Index
    
    V
  - Index
    
    V
  - VALUE

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t = Index(V).t

The type of the index.

val pp : t Fmt.t

Pretty-printer of t.

val memory_size : t -> int

memory_size t returns how many word(s) is needed to store t.

val make : ?copy:bool -> Cstruct.t -> t

make ?copy raw returns a Rabin's fingerprint of raw. ?copy signals to copy the input buffer raw or not because make expects to take the ownership of raw.

So, if the user want to change (by side-effect) raw then, returned value by make is not valid anymore. However, if copy is true, make will allocate a new Cstruct.t and copy raw to this new Cstruct.t.