package yocaml

  1. Overview
  2. Docs
Core engine of the YOCaml Static Site Generator

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (13)

Authors

  1. T
    The XHTMLBoy <xhtmlboi@gmail.com>

Maintainers

  1. T
    The XHTMLBoy <xhtmlboi@gmail.com>

Sources

yocaml-2.0.0.tbz
sha256=fddf61500e828ac88d86ba982084cc817299302082a6e797b36787ff18235ec2
sha512=8b71a8cecd3e101df55eef0bba7a24d4dde9d66b5ecedd9f6d55834fcdc8d33fd875092ca73a398e1715664caee06cdc1bdb1b4da85bff0a687faac5c0445023

doc/yocaml/Yocaml/Deps/index.html

Module Yocaml.DepsSource

A dependency set describes all the files required to build an artifact.

Types

Sourcetype t

The representation of a set of dependencies, containing Path.t. Under the bonnet, dependencies are defined by a Set.

Monoid

A dependency set is a monoid with the union of two sets as the internal composition operator and the empty set as the neutral element.

Sourceval concat : t -> t -> t

concat a b constructs the union of two sets of dependencies. concat a b = concat b a.

Sourceval empty : t

empty returns the neutral element of the monoid. It the empty set and concat neutral a = concat a neutral = a.

Sourceval reduce : t list -> t

reduce sets merge many sets in one.

Building

Sourceval singleton : Path.t -> t

singleton is a set with only one dependency.

Sourceval from_list : Path.t list -> t

from_list list build a set from a given list of path.

Compute deps

Retrieves information about sets of dependencies.

Sourceval get_mtimes : t -> int list Eff.t

get_mtimes deps Returns a list of modification dates for a set of dependencies.

Serialization/Deserialization

Supports serialization and deserialization of dependency sets.

Sourceval to_sexp : t -> Sexp.t

to_sexp deps Converts a set of dependencies, deps, into a Sexp.

Sourceval from_sexp : Sexp.t -> (t, Sexp.invalid) result

from_sexp sexp try to converts a Sexp into a set of dependencies.

Utils

Sourceval pp : Format.formatter -> t -> unit

Pretty-printer for t.

Sourceval equal : t -> t -> bool

Equality between t.

Sourceval is_empty : t -> bool

is_empty deps returns true if the dependencies set is empty, false if not.