package cohttp_static_handler

  1. Overview
  2. Docs

Module Asset.What_to_serveSource

Sourcetype t
Sourceval embedded : contents:string -> t
Sourceval embedded_with_filename : filename:string -> contents:string -> t
Sourceval file : relative_to:[ `Cwd | `Exe ] -> path:string -> t

file takes a string representing the path to serve, and if the path is relative, the relative_to parameter controls how the relative path resolution is performed:

  • `Cwd is relative to the current working directory. It is the way most tooling you're familiar with handles relative paths. It's useful for things like command line tools or other tools that operate on various files in the tree.
  • `Exe instead looks for files relative to the executable's dirname. This is useful for binaries that are always looking for files in the same (relative) location and is intended to be used for things like web servers that ship with static JavaScript and CSS assets.
Sourceval file_serve_as : relative_to:[ `Cwd | `Exe ] -> path:string -> serve_as:string -> t

See file for more information on relative_to behavior.