package b0

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

File indexes
Root directories
Directories
Files

Software construction and deployment kit

Install

dune-project

Dependency

erratique.ch Readme Changelog ISC; BSD-2-Clause License Edit opam file Versions (2)

Authors

T

The b0 programmers

Maintainers

Daniel Bünzli

Sources

b0-0.0.6.tbz

sha512=e9aa779e66c08fc763019f16d4706f465d16c05d6400b58fbd0313317ef33ddea51952e2b058db28e65f7ddb7012f328c8bf02d8f1da17bb543348541a2587f0

doc/b0.kit/B0_findex/index.html

Module `B0_findex`Source

File indexes.

TODO. Maybe move that back to brzo. At the b0 level we are trying something with B0_srcs.

File indexes

Sourcetype t

The type for file indexes.

Sourceval empty : t

empty is an empty file index.

Source

val of_dirs : 
  ?dotfiles:bool ->
  ?follow_symlinks:bool ->
  ?prune_dir:(Unix.stats -> string -> B0_std.Fpath.t -> bool) ->
  B0_std.Fpath.t list ->
  (t, string) result

of_dirs dirs returns a file index for the files in dirs whose prefixes may be reduced see root_root_dirs. See B0_std.Os.Dir.fold for the semantics of optional arguments.

Root directories

Sourceval root_dirs : t -> B0_std.Fpath.t list

root_dirs i are the directories that were indexed as given in of_dirs.

Sourceval root_root_dirs : t -> B0_std.Fpath.t list

root_root_dirs is B0_std.Fpath.drop_prefixed and B0_std.Fpath.distinct applied to root_dirs.

Directories

Sourceval dirs : t -> B0_std.Fpath.Set.t

dirs is the set of directories in the index, without the root directories.

Sourceval find_dirname : t -> string -> B0_std.Fpath.t list

find_dirname i n are the directories with basename n in i or the empty list if there is no such element.

Sourceval dir_files : t -> B0_std.Fpath.t -> B0_std.Fpath.t list

dir_files i d are the files in directory d. If d is not a root directory or a member of dirs this is the empty list.

Sourceval dir_dirs : t -> B0_std.Fpath.t -> B0_std.Fpath.t list

dir_dirs i d are the directories in directory d of i. If d is not a root directory or a member of dirs this is the empty list.

Files

Sourceval files : t -> B0_std.Fpath.Set.t

files is the set of files in the index.

Sourceval find_filename : t -> string -> B0_std.Fpath.t list

find_filename i n are the files with basename n in i or the empty list if there is no such element.