Skip to content

Commit 797d8e2

Browse files
committed
trpl/structs: Document unit-like structs
1 parent 457aed7 commit 797d8e2

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

src/doc/trpl/structs.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,3 +177,22 @@ println!("length is {} inches", integer_length);
177177
As you can see here, you can extract the inner integer type through a
178178
destructuring `let`, just as with regular tuples. In this case, the
179179
`let Inches(integer_length)` assigns `10` to `integer_length`.
180+
181+
# Unit-like structs
182+
183+
You can define a struct with no members at all:
184+
185+
```rust
186+
struct Electron;
187+
```
188+
189+
Such a struct is called ‘unit-like’ because it resembles the empty
190+
tuple, `()`, sometimes called ‘unit’. Like a tuple struct, it defines a
191+
new type.
192+
193+
This is rarely useful on its own (although sometimes it can serve as a
194+
marker type), but in combination with other features, it can become
195+
useful. For instance, a library may ask you to create a structure that
196+
implements a certain [trait][trait] to handle events. If you don’t have
197+
any data you need to store in the structure, you can just create a
198+
unit-like struct.

0 commit comments

Comments
 (0)