Display online doc url

Author: Cuihtlauac ALVARADO

README.md

@@ -10,3 +10,5 @@ C functions name prefixes are turned into modules. C functions name with suffix
 * `mongoc_database_get_collection_names_with_opts` is exposed as `Mongoc.Database.get_collection_names`
 
 The library `libbson` is exposed as a submodule `Mongoc.Bson`.
+
+Online documentation: https://tarides.github.io/mongoc-ocaml/mongoc/

lib/bson/bson.ml

@@ -32,6 +32,8 @@ end
 let some = Ctypes.allocate t
 let none = Ctypes.(from_voidp t null)
 
+let ptr_of_opt = Option.value ~default:none
+
 let get_version () =
   () |> C.Functions.get_version |> Ctypes_std_views.string_of_char_ptr
 
@@ -73,5 +75,4 @@ let as_relaxed_extended_json ?length (bson : t) =
 (* TODO: C.Functions.free (to_voidp str) *)
 
 let as_json = as_relaxed_extended_json
-
-let destroy (bson : t_struct ptr) = C.Functions.destroy bson |> ignore
+let destroy (bson : t) = C.Functions.destroy bson |> ignore

lib/bson/bson.mli

@@ -18,6 +18,7 @@ end
 
 val some : t_struct -> t
 val none : t
+val ptr_of_opt : t opt 
 val t : t_struct Ctypes_static.typ
 val get_version : unit -> string
 val get_major_version : unit -> int

lib/bson/type_description.ml

@@ -1,11 +1,12 @@
 module Types (F : Ctypes.TYPE) = struct
-  open Ctypes_static
   open F
 
   module Error = struct
     type t
 
-    let t : t structure typ = typedef (structure "bson_error_t") "bson_error_t"
+    let t : t Ctypes_static.structure typ =
+      typedef (structure "bson_error_t") "bson_error_t"
+
     let domain = field t "domain" uint32_t
     let code = field t "code" uint32_t
     let message = field t "message" (array 504 char)
@@ -14,6 +15,6 @@ module Types (F : Ctypes.TYPE) = struct
 
   type t
 
-  let t : t structure typ = typedef (structure "bson_t") "bson_t"
+  let t : t Ctypes_static.structure typ = typedef (structure "bson_t") "bson_t"
   let () = seal t
 end

lib/mongoc.ml

@@ -100,14 +100,14 @@ end = struct
   let find ?(opts : Bson.t option) ?(read_prefs : Read_prefs.t option)
       (coll : t) (filter : Bson.t) : Cursor.t =
     let opts = Option.value ~default:Bson.none opts in
-    let read_prefs = Option.value read_prefs ~default:Read_prefs.none in
+    let read_prefs = Option.value ~default:Read_prefs.none read_prefs in
     C.Functions.Collection.find_with_opts coll filter opts read_prefs
 
   let count_documents ?(opts : Bson.t option)
       ?(read_prefs : Read_prefs.t option) (coll : t) (filter : Bson.t) :
       (Int64.t, Bson.Error.t) result =
     let opts = Option.value ~default:Bson.none opts in
-    let read_prefs = Option.value read_prefs ~default:Read_prefs.none in
+    let read_prefs = Option.value ~default:Read_prefs.none read_prefs in
     let error = Ctypes.(make Bson.Error.t |> addr) in
     let count =
       C.Functions.Collection.count_documents coll filter opts read_prefs
@@ -119,11 +119,9 @@ end = struct
       (Bson.t, Bson.Error.t) result =
     let error = Ctypes.(make Bson.Error.t |> addr) in
     let opts = Option.value ~default:Bson.none opts in
-    let reply = Ctypes.make Bson.t in
-    if
-      C.Functions.Collection.insert_one coll document opts (Ctypes.addr reply)
-        error
-    then Ok (Ctypes.addr reply)
+    let reply = Ctypes.(make Bson.t |> addr) in
+    if C.Functions.Collection.insert_one coll document opts reply error then
+      Ok reply
     else Error error
 
   let drop (coll : t) =

lib/type_description.ml

@@ -1,38 +1,40 @@
 module Types (F : Ctypes.TYPE) = struct
-  open Ctypes_static
   open F
 
   module Error = struct
     type t
 
-    let t : t structure typ = typedef (structure "bson_error_t") "bson_error_t"
+    let t : t Ctypes_static.structure typ =
+      typedef (structure "bson_error_t") "bson_error_t"
+
     let () = seal t
   end
 
   module Read_prefs = struct
     type t
 
-    let t : t structure typ =
+    let t : t Ctypes_static.structure typ =
       typedef (structure "_mongoc_read_prefs_t") "mongoc_read_prefs_t"
   end
 
   module Uri = struct
     type t
 
-    let t : t structure typ = typedef (structure "_mongoc_uri_t") "mongoc_uri_t"
+    let t : t Ctypes_static.structure typ =
+      typedef (structure "_mongoc_uri_t") "mongoc_uri_t"
   end
 
   module Database = struct
     type t
 
-    let t : t structure typ =
+    let t : t Ctypes_static.structure typ =
       typedef (structure "_mongoc_database_t") "mongoc_database_t"
   end
 
   module Client = struct
     type t
 
-    let t : t structure typ =
+    let t : t Ctypes_static.structure typ =
       typedef (structure "_mongoc_client_t") "mongoc_client_t"
     (* Not sealing incomplete type. See
        https://github.com/yallop/ocaml-ctypes/issues/237 *)
@@ -41,14 +43,14 @@ module Types (F : Ctypes.TYPE) = struct
   module Collection = struct
     type t
 
-    let t : t structure typ =
+    let t : t Ctypes_static.structure typ =
       typedef (structure "_mongoc_collection_t") "mongoc_collection_t"
   end
 
   module Cursor = struct
     type t
 
-    let t : t structure typ =
+    let t : t Ctypes_static.structure typ =
       typedef (structure "_mongoc_cursor_t") "mongoc_cursor_t"
   end
 end