package git

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

MakeDeflater makes a module which respects the interface S.ENCODER from a S.MINIENC.encoder. As MakeEncoder, this module allocates one buffer from a size specified by the user. However this size must be a power of two.

This encoder encodes both the OCaml value and deflates the stream.

Parameters

module Z : sig ... end
module M : sig ... end

Signature

type t = M.e
type init = Cstruct.t * M.e * int * Cstruct.t
type error = [
  1. | `Deflate of Z.error
]
type encoder
val pp_error : error Fmt.t
val default : init -> encoder
val eval : Cstruct.t -> encoder -> [ `Flush of encoder | `End of encoder * int | `Error of error ]
val flush : int -> int -> encoder -> encoder
val used : encoder -> int