tvl-depot/tvix/eval/docs/builtins.md
Vincent Ambo c48aa058a7 docs(tvix/eval): add an overview of all builtins in Nix
Change-Id: Ie187f3317046c6c9e59852d4a128f25ceed99309
Reviewed-on: https://cl.tvl.fyi/c/depot/+/6252
Tested-by: BuildkiteCI
Reviewed-by: sterni <sternenseemann@systemli.org>
2022-09-02 12:59:23 +00:00

6.4 KiB

Nix builtins

Nix has a lot of built-in functions, some of which are accessible in the global scope, and some of which are only accessible through the global builtins attribute set.

This document is an attempt to track all of these builtins, but without documenting their functionality.

See also https://nixos.org/manual/nix/stable/expressions/builtins.html

name global arity pure
abort true 1
add false 2 true
addErrorContext false ?
all false 2 true
any false 2 true
appendContext false ?
attrNames false 1 true
attrValues false true
baseNameOf true
bitAnd false
bitOr false
bitXor false
builtins true
catAttrs false
compareVersions false
concatLists false
concatMap false
concatStringsSep false
currentSystem false
currentTime false
deepSeq false
derivation true
derivationStrict true
dirOf true
div false
elem false
elemAt false
false true
fetchGit true
fetchMercurial true
fetchTarball true
fetchurl false
filter false
filterSource false
findFile false
foldl' false
fromJSON false
fromTOML true
functionArgs false
genList false
genericClosure false
getAttr false
getContext false
getEnv false
hasAttr false
hasContext false
hashFile false
hashString false
head false
import true
intersectAttrs false
isAttrs false
isBool false
isFloat false
isFunction false
isInt false
isList false
isNull true
isPath false
isString false
langVersion false
length false
lessThan false
listToAttrs false
map true
mapAttrs false
match false
mul false
nixPath false
nixVersion false
null true
parseDrvName false
partition false
path false
pathExists false
placeholder true
readDir false
readFile false
removeAttrs true
replaceStrings false
scopedImport true
seq false
sort false
split false
splitVersion false
storeDir false
storePath false
stringLength false
sub false
substring false
tail false
throw true
toFile false
toJSON false
toPath false
toString true
toXML false
trace false
true true
tryEval false
typeOf false
unsafeDiscardOutputDependency false
unsafeDiscardStringContext false
unsafeGetAttrPos false
valueSize false