package capnp
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=7b67b28a097559cad5fba538afb108eefbb4ee24b30e3cfb9dcd387619652049
sha512=d2c7133e0269e1162fa3ba320699759978e92f2c1ee606ce25353c1651e8311a382ec4b9dc2b4a9f51666821ed2ebb55619053b11c8bcdff8b0daa0fd004a9cb
CHANGES.md.html
v3.3.0
This release is mostly about reducing the number of dependencies. The only API change is that write_message_to_file_robust
has gone.
Remove
extunix
dependency (#57).write_message_to_file_robust
was its only user, and wasn't used by anything. Usingfsync
to ensure a file is written to disk is a general function that should be handled by the user of capnp where needed. Removingextunix
also removes the indirect dependency oncamlp4
, which in turn allowscapnp
to build with OCaml 4.08 (and to build faster on all versions).Remove
Pervasives
qualifier (#57). This is needed to support OCaml 4.08 without warnings.Remove dependency on
Core
from benchmarks (#55). This was the only remaining use of the library.Replace uses of
Core_kernel
with plainBase
andStdio
in the compiler (#56) and tests (#59). This greatly reduces the number of libraries you need to install to install capnp.Update tests for the current quickcheck API (#54).
Switch from jbuilder to dune (#54).
Require OCaml >= 4.03 (#54). This allows us to drop some complexity from the jbuilder files, allowing them to be upgraded automatically by dune.
Upgrade to opam 2 format (#54).
Convert the changelog to markdown (#58). This allows it to be used with dune-release.
With these changes, the following 49 libraries that were needed to install capnp-ocaml 3.2.1 are no longer required: base_bigstring
, base_quickcheck
, bin_prot
, camlp4
, core_kernel
, extunix
, fieldslib
, jane-street-headers
, jst-config
, num
, ocaml-compiler-libs
, ocaml-migrate-parsetree
, octavius
, parsexp
, ppx_assert
, ppx_base
, ppx_bench
, ppx_bin_prot
, ppx_compare
, ppx_custom_printf
, ppx_derivers
, ppx_enumerate
, ppx_expect
, ppx_fail
, ppx_fields_conv
, ppx_hash
, ppx_here
, ppx_inline_test
, ppx_jane
, ppx_js_style
, ppx_let
, ppxlib
, ppx_module_timer
, ppx_optcomp
, ppx_optional
, ppx_pipebang
, ppx_sexp_conv
, ppx_sexp_message
, ppx_sexp_value
, ppx_stable
, ppx_typerep_conv
, ppx_variants_conv
, re
, seq
, sexplib
, splittable_random
, time_now
, typerep
and variantslib
.
v3.2.1
Other changes
Update for API changes in Base and Core_kernel (#52).
v3.2.0
Backwards-incompatible changes
The
capnp
opam package no longer depends on the C++ compiler (#47). If your project compiles schema files, you should add"conf-capnproto" {build}
to your opam dependencies.
Other changes
Add support for OCaml 4.06 (#45).
Update for API changes in Base and Core_kernel (#44).
v3.1.0
Backwards-incompatible changes
The Unix-specific
IO
module has been moved fromCapnp.IO
toCapnp_unix.IO
, and is now part of the newcapnp.unix
ocamlfind library. Bothcapnp
andcapnp.unix
ocamlfind libraries are provided by thecapnp
opam package.
New features
The core
capnp
library no longer depends onCore_kernel
orUnix
. This makes binaries using the library several MB smaller and allows capnp to be used in Mirage unikernels.
v3.0.0
Backwards-incompatible changes
The
Builder.X.reader_t
andReader.X.builder_t
types have gone (to avoid confusion with the genericreader_t
andbuilder_t
types). UseX.struct_t reader_t
andX.struct_t builder_t
instead.Builder.X.t
is still defined (as an alias fort builder_t
), and similarly forReader.X.t
.StructStorage.t
now takes an extra type parameter. This is a phantom type, used to indicate what kind of struct it represents. This extra parameter has also been added toObject.t
.In the generated files, the unique types names (e.g.
reader_t_Foo_14133145859926553711
) have gone. If you need to refer to these directly for some reason, use the replacement polymorphic type instead (e.g.Foo_c42305476bb4746f reader_t
).
New features
RPC support (#35 and #36). The compiler now generates readers and builders for parameters and results, interface and method IDs, and a dispatch method for services. There is a new
MakeRPC
functor in the generated files that takes an extended version ofMessageSig
. The originalMake
is still provided - it is now a convenience wrapper aroundMakeRPC
that passes some dummy functions. An RPC provider is available at https://github.com/mirage/capnp-rpc.Capability references can now be attached to messages. The getters and setters that previously took
Uint32.t
indexes can now take capabilities, as defined by an RPC provider library. The defaultRPC.None
provider exposes the raw descriptor index, as before.Better AnyPointer support (#11). The new
of_pointer
andinit_pointer
functions can be used to read and add structs of any type to AnyPointer fields. The newpointer_set_reader
can be used to set a pointer by copying from a reader.Replace camlp4 includes with flambda inlining (#23). The
-inc.ml
files that were previously copied into each generated file are now regular modules in the library, making them available to other code too. This makes the generated files much smaller. There is no performance penalty (when using flambda).Port to jbuilder (#24). Also, the required schema files are now included in the repository rather than being downloaded by the build scripts, which was fragile.
Add support for cycles (#29). Before, the compiler would abort if a schema file contained cycles, but this is very common (especially with interfaces). It now generates forward references where needed.
Add parameterised
reader_t
andbuilder_t
types (#32 and #33). Instead of providingReader.Foo.t
andBuilder.Foo.t
as abstract types, provide a singleFoo.struct_t
and usestruct_t reader_t
andstruct_t builder_t
for its reader and builder. This makes it possible to define generic functions that work on all readers or builders, without having to generate a separate function for each one. The types are shared between files, so you can write generic code to work with schema files you haven't seen (needed for the RPC system).Use polymorphic variants for phantom types (#34). Instead of declaring a load of unique type names at the start of the file, use polymorphic variants. These don't need to be declared before use. The node ID is now formatted as hex, to make it shorter and to match the format used in the schema files. There are new generic
reader_of_builder
andmessage_of_builder
functions inStructStorage
.
Other changes
All uses of
Obj.magic
have been removed from the generated code.Update to latest core_kernel (#26). Avoids conflict with newer sexplib.
Fix some compiler warnings (#28). Jbuilder turns on more warnings by default.
Add missing test dependency on ounit (#30).
Fix code generation bug in 2.1.1 (#10). A missing space prevented the generated files from compiling. Added Travis CI tests to detect this kind of thing automatically.
v2.1.1
Fix
Not_found
exception when a capnp import is not referenced within the schema file.Omit references to capnp imports which are not used within the generated code. In particular, importing
"/capnp/c++.capnp"
no longer generates a reference to an OCaml module with the confusing name ofC2b2b
, and there should no longer be a need to separately compile that imported schema file.
v2.1.0
Depend on Core_kernel rather than Core. Thanks to Matthew Maurer for driving this change.
Fix compatibility issue when building against Core 112.35.00.
v2.0.1
Invoke OCaml scripts using
-I $OCAML_TOPLEVEL_PATH
, to avoid missingtopfind
.
v2.0.0
Backwards-incompatible changes
Module
Codecs
: change API to accept the more naturalBytesMessage.Message.t
instead ofBytes.t list
.Module
Codecs
: change API to accept acompression
specifier, instead of using separate functions and separate types for compressed and uncompressed streams.Module
Message
:to_storage
now returns a list of (storage, length) pairs.
Other changes
Module
Codecs
: fix incorrect encoding of framing headers (for example, as generated byserialize
).Module
Codecs
: fix infinite loop inPackedStream
decoding.Module
Codecs
: reduce serialized message sizes, by omitting unused allocation regions from the serialized messages.Instantiate
BytesMessage = Message.Make(BytesStorage)
, so the user doesn't always need to. (Implementation is furthermore defunctorized for improved performance.)New module
IO
: functions for moving message data through various types of I/O channels.Compiler now says something about files it created.
Corrected compilation errors when using 4.02
-safe-string
.Significant performance improvements across the board.
v1.0.1
Avoid use of GNU
install
features inomake install
. This corrects installation problems on OS X and (most likely) other BSDs.
v1.0.0
Initial release.