What is a crate attribute and where do I add it?

rust rust-cargo
Soham Chowdhury picture Soham Chowdhury · Dec 13, 2014 · Viewed 18.8k times · Source

In order to get a feel for how Rust works, I decided to look at a little terminal-based text editor called Iota. I cloned the repository and ran cargo build only to be told:

error: *if let* syntax is experimental

help: add #![feature(if_let)] to the crate attributes to enable

Where am I supposed to add #![feature(if_let)] to the crate attributes?

Answer

Shepmaster picture Shepmaster · Dec 13, 2014

A crate attribute is an attribute (#[...]) that applies to the enclosing context (#![...]). This attribute must be added to the top of your crate root, thus the context is the crate itself: 

#![attribute_name]
#![attribute_name(arg1, ...)]

If you are creating

  • a library — the crate root will be a file called lib.rs
  • an application — the crate root would be the primary .rs file you build. In many cases, this will be called main.rs
  • an integration test - the crate root is each file in tests/
  • an example - the crate root is each file in examples/

The Rust Programming Language and the Rust Reference talk a bit about attributes in general. The Unstable Book contains a list of feature flags and brief documentation on what they do.

There are many different crate attributes, but the feature crate attribute (#![feature(feature1, feature2)]) may only be used in a nightly version of the compiler. Unstable features are not allowed to be used in stable Rust versions.

Related questions

Rust package with both a library and a binary?

I would like to make a Rust package that contains both a reusable library (where most of the program is implemented), and also an executable that uses it. Assuming I have not confused any semantics in the Rust module system, …

Read More
Why are Rust executables so huge?

Just having found Rust and having read the first two chapters of the documentation, I find the approach and the way they defined the language particularly interesting. So I decided to get my fingers wet and started out with Hello …

Read More
How to launch a Rust application from Visual Studio Code?

I have installed the Visual Studio Code extensions for Rust: I want to run my project and I don't understand where to click. I tried clicking Run Task, Run build task, Configure Default build task, but nothing reasonable happens.

Read More