Metadata

In using Nu, you may have come across times where you felt like there was something extra going on behind the scenes. For example, let’s say that you try to open a file that Nu supports only to forget and try to convert again:

  1. > open Cargo.toml | from toml
  2. error: Expected a string from pipeline
  3. - shell:1:18
  4. 1 | open Cargo.toml | from toml
  5.   |                   ^^^^^^^^^ requires string input
  6. - shell:1:5
  7. 1 | open Cargo.toml | from toml
  8.   |      ---------- object originates from here

The error message tells us not only that what we gave from toml wasn’t a string, but also where the value originally came from. How would it know that?

Values that flow through a pipeline in Nu often have a set of additional information, or metadata, attached to them. These are known as tags, like the tags on an item in a store. These tags don’t affect the data, but they give Nu a way to improve the experience of working with that data.

Let’s run the open command again, but this time, we’ll look at the tags it gives back:

  1. > open Cargo.toml | metadata
  2. ────────┬───────────────────────────────────────────
  3.  span   │ {record 2 fields}
  4. ────────┴───────────────────────────────────────────

Currently, we track only the span of where values come from. Let’s take a closer look at that:

  1. > open Cargo.toml | metadata | get span
  2. ───────┬────
  3.  start │ 5
  4.  end   │ 15
  5. ───────┴────

The span “start” and “end” here refer to where the underline will be in the line. If you count over 5, and then count up to 15, you’ll see it lines up with the “Cargo.toml” filename. This is how the error we saw earlier knew what to underline.