(*
 * Copyright (c) 2014 Leo White <leo@lpw25.net>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *)

open Or_error


val load : string -> in_channel -> (Odoc_model.Root.t, [> msg ]) result
(** [load fn ic] reads a {!t} from [ic].
    [fn] is the name of the file [ic] is "watching", and is used for error
    reporting. *)

val read : Fs.File.t -> (Odoc_model.Root.t, [> msg ]) result
(** [read f] opens [f] for reading and then calls {!load}. *)

val save : out_channel -> Odoc_model.Root.t -> unit
(** [save oc t] marshalls [t] to [oc]. *)
