package irmin

  1. Overview
  2. Docs

Module Node.PathSource

Path provides base functions on node paths.

Path

Sourcetype t

The type for path values.

Sourcetype step

Type type for path's steps.

Sourceval empty : t

The empty path.

Sourceval v : step list -> t

Create a path from a list of steps.

Sourceval is_empty : t -> bool

Check if the path is empty.

Sourceval cons : step -> t -> t

Prepend a step to the path.

Sourceval rcons : t -> step -> t

Append a step to the path.

Sourceval decons : t -> (step * t) option

Deconstruct the first element of the path. Return None if the path is empty.

Sourceval rdecons : t -> (t * step) option

Deconstruct the last element of the path. Return None if the path is empty.

Sourceval map : t -> (step -> 'a) -> 'a list

map t f maps f over all steps of t.

Value Types

t is the value type for t.

step_t is the value type for step.