1
1
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2025-12-08 18:11:02 +01:00
nix/doc/manual/source/language/operators.md
2025-12-07 14:10:16 +01:00

12 KiB
Raw Blame History

Operators

Name Syntax Associativity Precedence
Attribute selection attrset . attrpath [ or expr ] none 1
Function application func expr left 2
Arithmetic negation - number none 3
Has attribute attrset ? attrpath none 4
List concatenation list ++ list right 5
Multiplication number * number left 6
Division number / number left 6
Subtraction number - number left 7
Addition number + number left 7
String concatenation string + string left 7
Path concatenation path + path left 7
Path and string concatenation path + string left 7
String and path concatenation string + path left 7
Logical negation (NOT) ! bool none 8
Update attrset // attrset right 9
Less than expr < expr none 10
Less than or equal to expr <= expr none 10
Greater than expr > expr none 10
Greater than or equal to expr >= expr none 10
Equality expr == expr none 11
Inequality expr != expr none 11
Logical conjunction (AND) bool && bool left 12
Logical disjunction (OR) bool || bool left 13
Logical implication bool -> bool right 14
Pipe operator (experimental) expr |> func left 15
Pipe operator (experimental) func <| expr right 15

Attribute selection

Syntax

attrset . attrpath [ or expr ]

Select the attribute denoted by attribute path attrpath from attribute set attrset. If the attribute doesnt exist, return the expr after or if provided, otherwise abort evaluation.

Function application

Syntax

func expr

Apply the callable value func to the argument expr. Note the absence of any visible operator symbol. A callable value is either:

Warning

List items are also separated by whitespace, which means that function calls in list items must be enclosed by parentheses.

Has attribute

Syntax

attrset ? attrpath

Test whether attribute set attrset contains the attribute denoted by attrpath. The result is a Boolean value.

See also: builtins.hasAttr

After evaluating attrset and attrpath, the computational complexity is O(log(n)) for n attributes in the attrset

Arithmetic

Numbers will retain their type unless mixed with other numeric types: Pure integer operations will always return integers, whereas any operation involving at least one floating point number returns a floating point number.

Evaluation of the following numeric operations throws an evaluation error:

  • Division by zero
  • Integer overflow, that is, any operation yielding a result outside of the representable range of Nix language integers

See also Comparison and Equality.

The + operator is overloaded to also work on strings and paths.

String concatenation

Syntax

string + string

Concatenate two strings and merge their string contexts.

Path concatenation

Syntax

path + path

Concatenate two paths. The result is a path.

Path and string concatenation

Syntax

path + string

Concatenate path with string. The result is a path.

Note

The string must not have a string context that refers to a store path.

String and path concatenation

Syntax

string + path

Concatenate string with path. The result is a string.

Important

The file or directory at path must exist and is copied to the store. The path appears in the result as the corresponding store path.

Update

Syntax

attrset1 // attrset2

Update attribute set attrset1 with names and values from attrset2.

The returned attribute set will have all of the attributes in attrset1 and attrset2. If an attribute name is present in both, the attribute value from the latter is taken.

This operator is strict in both attrset1 and attrset2. That means that both arguments are evaluated to weak head normal form, so the attribute sets themselves are evaluated, but their attribute values are not evaluated.

Comparison

Comparison is

  • arithmetic for numbers
  • lexicographic for strings and paths
  • item-wise lexicographic for lists: elements at the same index in both lists are compared according to their type and skipped if they are equal.

All comparison operators are implemented in terms of <, and the following equivalencies hold:

comparison implementation
a <= b ! ( b < a )
a > b b < a
a >= b ! ( a < b )

Equality

  • Attribute sets are compared first by attribute names and then by items until a difference is found.
  • Lists are compared first by length and then by items until a difference is found.
  • Comparison of distinct functions returns false, but identical functions may be subject to value identity optimization.
  • Numbers are type-compatible, see arithmetic operators.
  • Floating point numbers only differ up to a limited precision.

The == operator is strict in both arguments; when comparing composite types (attribute sets and lists), it is partially strict in their contained values: they are evaluated until a difference is found.

Value identity optimization

Nix performs equality comparisons of nested values by pointer equality or more abstractly, identity. Nix semantics ideally do not assign a unique identity to values as they are created, but equality is an exception to this rule. The disputable benefit of this is that it is more efficient, and it allows cyclical structures to be compared, e.g. let x = { x = x; }; in x == x evaluates to true. However, as a consequence, it makes a function equal to itself when the comparison is made in a list or attribute set, in contradiction to a simple direct comparison.

Logical conjunction

Syntax

bool1 && bool2

Logical AND. Equivalent to if bool1 then bool2 else false.

This operator is strict in bool1, but only evaluates bool2 if bool1 is true.

Example

true && false
=> false

false && throw "never evaluated"
=> false

Logical disjunction

Syntax

bool1 || bool2

Logical OR. Equivalent to if bool1 then true else bool2.

This operator is strict in bool1, but only evaluates bool2 if bool1 is false.

Example

true || false
=> true

true || throw "never evaluated"
=> true

Precedence and disjunctive normal form

The precedence of && and || aligns with disjunctive normal form. Without parentheses, an expression describes multiple "permissible situations" (connected by ||), where each situation consists of multiple simultaneous conditions (connected by &&).

For example, A || B && C || D && E is parsed as A || (B && C) || (D && E), describing three permissible situations: A holds, or both B and C hold, or both D and E hold.

Logical implication

Syntax

bool1 -> bool2

Logical implication. Equivalent to !bool1 || bool2 (or if bool1 then bool2 else true).

This operator is strict in bool1, but only evaluates bool2 if bool1 is true.

Example

true -> false
=> false

false -> throw "never evaluated"
=> true

Pipe operators

  • a |> b is equivalent to b a
  • a <| b is equivalent to a b

Example

nix-repl> 1 |> builtins.add 2 |> builtins.mul 3
9

nix-repl> builtins.add 1 <| builtins.mul 2 <| 3
7

Warning

This syntax is part of an experimental feature and may change in future releases.

To use this syntax, make sure the pipe-operators experimental feature is enabled. For example, include the following in nix.conf:

extra-experimental-features = pipe-operators