Rust Doc Days Follow Up

A few weeks ago, I mentioned Rust Doc Days. This was an event where the Rust community made a conscious effort to improve Rust’s documentation. Throughout this blog post, “we” refers to the quasi-official Rust docs team. How did it go? The first Rust Doc Days was, we felt, a successful event. We deliberately kept the event low…
Read More

Announcing Rust Doc Days

Documentation is an important, but overlooked, part of programming. While we can’t make you write documentation, we’re hoping that we can help you remember that good documentation means people are more likely to use the tools that you build. To that point, we (the quasi-official Rust docs team) have organized Rust Doc Days. Writing documentation…
Read More

Writing Documentation in Rust

Documentation is important. It’s also easy to do. Rust ships with tools to help developers create documentation for their libraries. Code Comments The main way that many developers write documentation is through source code comments. A single-line comment in Rust is started with //. Many programming languages should already use this construct, so it’s probably…
Read More

The State of Rust Docs

Every week I hop on IRC and meet with an unofficial Rust documentation team. Our goal is to take a look at documentation across the Rust ecosystem and to figure out how to improve the general state of things. Our work covers a lot of space and includes documentation tooling, centralized documentation, and reviewing the…
Read More

Hijacking stderr in Rust

Liberate your output pipes from the tyranny of programmatic control! Let’s say you have to work with OS processes – you’re building tools for automation and you need to capture the output of a command with your Rust program. You might need to process the command’s output and do something with it, but you also…
Read More

Talking About Rust’s Traits

We previously talked about The Basics of Rust structs. That was some pretty cool stuff – we learned how to structure data and how to attach functionality to that data by using impl. A struct defines what data we have, but what if we want to define how that data should function? Using the traits…
Read More

The Basics of Rust Structs

Pretty structs, as far as the eye can see… structs are one of the basic building blocks in Rust. A struct lets us create more complex data types of our own. Instead of having to jump through naming hoops to make our own data structures, we can create whatever we want. Our First Rust struct…
Read More

Error Handling in Rust

I’ve been doing some programming in Rust recently. First was a flake generator and then the second is a rudimentary implementation of the ls command (dir to Windows people) – I submitted a pull request to uutils/coreutils: a replacement for the UNIX coreutils suite of software. Error handling plays a big role in both of these chunks of…
Read More

Installing Rust on Windows

Installing Rust can be as easy as pulling down an installer and double clicking. For developers working with more complex tools or who need to build unsafe C/C++ libraries from source, there’s a little bit of extra work that needs to be done, but it’s nothing that a savvy person can’t handle. Throughout this whole…
Read More
Menu