Merge pull request #22 from avsm/master

Add `to_bigarray` to convert back into a Bigarray slice.

Author: avsm

CHANGES

@@ -1,5 +1,6 @@
-trunk (unreleased)
-* Improve bounds checks on sub, shift, set_len, add_len
+1.1.0 (2014-02-19)
+* Improve bounds checks on sub, shift, set_len, add_len.
+* Add `to_bigarray` to convert back into a Bigarray slice.
 
 1.0.1 (2013-12-09):
 * Fix Cstruct.shift function

_oasis

@@ -1,6 +1,6 @@
 OASISFormat: 0.3
 Name:        cstruct
-Version:     1.0.1
+Version:     1.1.0
 Synopsis:    Manipulate external buffers as C-like structs
 Authors:     Anil Madhavapeddy, Richard Mortier, Thomas Gazagnaire, Pierre Chambart
 License:     ISC

_tags

@@ -1,9 +1,9 @@
 true: inline(10)
 true: debug
 # OASIS_START
-# DO NOT EDIT (digest: 60dceed12f46a3257c5355789042d89e)
-# Ignore VCS directories, you can use the same kind of rule outside 
-# OASIS_START/STOP if you want to exclude directories that contains 
+# DO NOT EDIT (digest: 623ae0a45fad2527c26cc490691b077a)
+# Ignore VCS directories, you can use the same kind of rule outside
+# OASIS_START/STOP if you want to exclude directories that contains
 # useless stuff for the build process
 <**/.svn>: -traverse
 <**/.svn>: not_hygienic

lib/META

@@ -1,6 +1,6 @@
 # OASIS_START
-# DO NOT EDIT (digest: 762d7a6f73f805c365e1539014f0009c)
-version = "1.0.1"
+# DO NOT EDIT (digest: b4981197fe71fb2a248209688d5e96a0)
+version = "1.1.0"
 description = "Manipulate external buffers as C-like structs"
 requires = "bigarray ocplib-endian ocplib-endian.bigstring"
 archive(byte) = "cstruct.cma"
@@ -9,7 +9,7 @@ archive(native) = "cstruct.cmxa"
 archive(native, plugin) = "cstruct.cmxs"
 exists_if = "cstruct.cma"
 package "unix" (
- version = "1.0.1"
+ version = "1.1.0"
  description = "Manipulate external buffers as C-like structs"
  requires = "cstruct unix"
  archive(byte) = "unix_cstruct.cma"
@@ -20,16 +20,20 @@ package "unix" (
 )
 
 package "syntax" (
- version = "1.0.1"
+ version = "1.1.0"
  description = "Syntax extension for Cstruct"
  requires = "camlp4"
  archive(syntax, preprocessor) = "cstruct-syntax.cma"
  archive(syntax, toploop) = "cstruct-syntax.cma"
+ archive(syntax, byte) = "cstruct-syntax.cma"
+ archive(syntax, byte, plugin) = "cstruct-syntax.cma"
+ archive(syntax, native) = "cstruct-syntax.cmxa"
+ archive(syntax, native, plugin) = "cstruct-syntax.cmxs"
  exists_if = "cstruct-syntax.cma"
 )
 
 package "lwt" (
- version = "1.0.1"
+ version = "1.1.0"
  description = "Manipulate external buffers as C-like structs"
  requires = "cstruct lwt.unix"
  archive(byte) = "lwt_cstruct.cma"
@@ -40,7 +44,7 @@ package "lwt" (
 )
 
 package "async" (
- version = "1.0.1"
+ version = "1.1.0"
  description = "Manipulate external buffers as C-like structs"
  requires = "cstruct async threads"
  archive(byte) = "async_cstruct.cma"

lib/cstruct.ml

@@ -31,6 +31,9 @@ let of_bigarray ?(off=0) ?len buffer =
     |Some len -> min len (Bigarray.Array1.dim buffer)
   in { buffer; off; len }
 
+let to_bigarray buffer =
+  Bigarray.Array1.sub buffer.buffer buffer.off buffer.len
+
 let create len =
   let ba = Bigarray.Array1.create Bigarray.char Bigarray.c_layout len in
   of_bigarray ba

lib/cstruct.mli

@@ -162,12 +162,17 @@ type uint64 = int64
 (** 64-bit unsigned integer.  The representation is currently a
     boxed OCaml int64. *)
 
-(** {2 Creation} *)
+(** {2 Creation and conversion} *)
 
 val of_bigarray: ?off:int -> ?len:int -> buffer -> t
 (** [of_bigarray ~off ~len b] is the cstruct contained in [b] starting
     at [off], of length [len]. *)
 
+val to_bigarray: t -> buffer 
+(** [to_bigarray t] converts a {!t} into a {!buffer} Bigarray, using
+    the Bigarray slicing to allocate a fresh array that preserves
+    sharing of the underlying buffer. *)
+
 val create : int -> t
 (** [create len] is a cstruct of size [len] with an offset of 0. *)