Indented (Multi-line String)

Definition

Indented { indent :: Int, parts :: [Antiquoted Text] }

Fields

Nix Source ↔ AST

Simple Indented String

# Nix
''
  hello
  world
''

# String node
{
  "tag": "Indented",
  "indent": 2,
  "parts": [
    { "tag": "Plain", "contents": "hello\nworld" }
  ]
}

With Antiquotation

# Nix
''
  hello
  ${name}
''

# String node
{
  "tag": "Indented",
  "indent": 2,
  "parts": [
    { "tag": "Plain", "contents": "hello\n" },
    { "tag": "Antiquoted", "contents": { "tag": "Sym", "contents": "name" } }
  ]
}

Escaped Newline

# Nix
''
  first line \
  second line
''

# String node
{
  "tag": "Indented",
  "indent": 2,
  "parts": [
    { "tag": "Plain", "contents": "first line " },
    { "tag": "EscapedNewline" },
    { "tag": "Plain", "contents": "second line" }
  ]
}

Expression Wrapper

{
  "tag": "Str",
  "contents": { "tag": "Indented", "indent": 2, "parts": [...] }
}

Related

• DoubleQuoted: standard strings
• Antiquoted: Plain, Antiquoted, EscapedNewline parts
• Str: expression wrapper

Nix Library Access

syntax.mkStr (syntax.mkIndented 2 [syntax.mkPlain "hello\nworld"])