package oepub

  1. Overview
  2. Docs

Module Oepub.EpubArchiveSource

Entry point of the library to open epub archive

Sourcetype t

The epub archive type

Sourceval parse : string -> t

parse file unzips the archive name file.

  • raises Zip.Error

    if the archive can not to be unzipped.

Sourceval close : t -> unit

close epub closes the underlying archive handler

Sourceval files : t -> string list

files epub returns the list of files contained in the archive

Sourceval handler : t -> Zip.in_file

handler epub returns the underlying zip handler

Sourceval read_entry : t -> string -> string option

read_entry epub filename returns the content of filename in epub. read_entry returns None if filename is not a file in epub.

Sourceval opf : t -> (Opf.t, Error.t) result

opf epub tries to parse the content.opf file

Sourceval toc : t -> (Toc.t, Error.t) result

toc epub tries to parse the toc.ncx file