Take a break while compiling.

Radek Vít

Last update: Oct 2, 2024

Related tags

Command-line coffee_break

Overview

Coffee break

Coffee break is a 🔥 blazing 🚀 fast 🦀 Rust 🥵 library, by Rust developers for Rust developers. It is:

Developer-friendly: Lets you take a break while compiling your code.
Eco-friendly: The compiler is just taking a nap. We're not computing the Ackermann function just to slack off.
Language server-unfriendly: rust-analyzer has insomnia now.

Overview

A classic XKCD webcomic

45% of respondents to the 2023 Rust survey were concerned with Rust's compile times, and they're right: they're too dang fast!

In the before times when working on old C++ projects, we used to get 10 to 40 minutes of free time after we hit compile to do whatever we wanted. Developers' computers had no more than 2 to 4 CPU cores, and Makefiles were often not configured to run in parallel at all.

Nowadays, the devious Rust compiler developers are trying to make the compiler even faster, and they're slowly succeeding.

Here comes Coffee break, a friendly developer tool to make this problem go away.

Example

Before you run cargo build, reward yourself with a coffee break:

use coffee_break::coffee_break;

fn work_stuff() {
    let maybe = |(true|false)||(false|true)||(true|false)|true;
    let absolutely = maybe(true)(true)(true);

    // Take a break and hit compile
    coffee_break!(5 minutes);
}

You just got 5 minutes to stretch your legs, get a coffee, or make Friday afternoon a bit nicer.

You can take a break for up to 251 minutes, or up to 1319 seconds. These limits are arbitrary, and will not be changed for any reason, unless the author changes their mind.

This crate requires correct grammar:

fn work_stuff() {
    coffee_break!(1 second); // OK
    coffee_break!(5 minutes); // OK
    // coffee_break!(59 second); // Error
    // coffee_break!(1 minutes); // Error
}

You can still run cargo check and cargo clippy without having to wait.

Notes

The author doesn't drink coffee, but still enjoys taking a break.

Contributing

Before contributing to this project, consider taking a coffee break first.

PRs are welcome. The first paragraph of any PR message must be a haiku describing the changes.

Please follow the community guidelines.

License

This project is licensed under a license modeled on the JSON license. Evil doesn't deserve a break.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Coffee break by you, shall be licensed with this repository's license, without any additional terms or conditions.

Docker images for compiling static Rust binaries using musl-libc and musl-gcc, with static versions of useful C libraries. Supports openssl and diesel crates.

rust-musl-builder: Docker container for easily building static Rust binaries Source on GitHub Changelog UPDATED: Major updates in this release which m

1.3k Jan 1, 2023

Docker images for compiling static Rust binaries using musl-cross

rust-musl-cross Docker images for compiling static Rust binaries using musl-cross-make, inspired by rust-musl-builder Prebuilt images Currently we hav

365 Dec 30, 2022

Everything you need to know about cross compiling Rust programs!

rust-cross Everything you need to know about cross compiling Rust programs! If you want to set up your Rust toolchain as a cross compiler, you have co

2.3k Jan 2, 2023

A collection of compilers based around compiling a high level language to a Brainfuck dialect.

tf A collection of compilers based around compiling a high level language to a Brainfuck dialect. Built at, and for, the VolHacks V hackathon during O

6 Nov 25, 2021

Easy-to-use wrapper for WebRTC DataChannels peer-to-peer connections written in Rust and compiling to WASM.

58 Dec 11, 2022

MidenIR for compiling to Miden Assembly from higher-level languages

Miden IR This repository provides a compiler for the Miden VM, specifically for Miden Assembly. It does this by lowering from a higher-level intermedi

10 Mar 30, 2023

Rust library for compiling and running other programs.

Exers 💻 Exers is a rust library for compiling and running code in different languages and runtimes. Usage example fn main() { // Imports...

5 Jun 10, 2023

A blazingly fast compiling & optimization tool for CosmWasm smart contracts.

cw-optimizoor A blazingly fast alternative to CosmWasm/rust-optimizer for compiling & optimizing CW smart contracts. It's primarily meant to speed up

37 Apr 15, 2023

Utilities for working with native solc and compiling projects.

foundry-compilers Utilities for working with native solc and compiling projects. To also compile contracts during cargo build (so that ethers abigen!

9 Oct 4, 2023

MASQ combines the benefits of VPN and Tor technology to create a superior next-generation privacy software, where users are rewarded for supporting an uncensored global web. Users gain privacy and anonymity online, while helping promote Internet Freedom.

MASQ Node Source The MASQ project was forked from Substratum's Node project in order to carry on development after Substratum ceased operations in Oct

121 Dec 20, 2022

ripgrep recursively searches directories for a regex pattern while respecting your gitignore

ripgrep (rg) ripgrep is a line-oriented search tool that recursively searches the current directory for a regex pattern. By default, ripgrep will resp

35k Jan 2, 2023

A programming environment that aims to help people learn how to program in JavaScript, while giving them a tour on how old computers and their limitations used to be.

This repository is for the new under renovation rewrite of the LIKO-12 project. The legacy version with the original stars and contributions is still

1k Jan 5, 2023

Midnote is a terminal application that reads a MIDI file and displays you its notes bar-by-bar, while playing it.

MIDNOTE Midnote is a terminal application that reads a MIDI file and displays you its notes bar-by-bar, while playing it. Goals As a blind musician my

4 Oct 30, 2022

Collects accurate files while running in parallel through directories. (Simple, Fast, Powerful)

collectfiles Collects accurate files while running in parallel through directories. (Simple, Fast, Powerful) | Docs | Latest Note | [dependencies] col

2 Jun 1, 2022

Auritia is a DAW coded in Rust and Vue in hopes of having cross platform compatability, while also providing enough features for anyone to use professionally

Steps Install WebView if you're not on Windows 11 Install Node deps npm i To run the dev server do npm run tauri dev Compiling Linux You will need to

20 Aug 27, 2022

ripgrep recursively searches directories for a regex pattern while respecting your gitignore

ripgrep (rg) ripgrep is a line-oriented search tool that recursively searches the current directory for a regex pattern. By default, ripgrep will resp

35k Dec 31, 2022

A collection of algorithms that can do join between two parties while preserving the privacy of keys on which the join happens

Private-ID Private-ID is a collection of algorithms to match records between two parties, while preserving the privacy of these records. We present tw

169 Dec 5, 2022

handle some lichess.org/tournament load with rust, while learning rust

lila-http Take some of the HTTP load away from lila. WIP! Arena tournaments Clients connected to a tournament page request new data about the tourname

22 Jan 2, 2023

Canary - Distributed systems library for making communications through the network easier, while keeping minimalism and flexibility.

Canary Canary is a distributed systems and communications framework, focusing on minimalism, ease of use and performance. Development of Canary utiliz

28 Nov 3, 2022

Comments

Remove `quote` dependency
quote's only usage is returning a unit () statement. This behavior can be accomplished by calling TokenStream::new, which returns an empty token stream.

This does change the generated output, but it still accomplishes the same result.

// stretch_your_legs.rs // Before fn main() { (); } // After fn main() { }

Unfortunately it only removes quote as an immediate dependency. syn still dependends on quote, even when I reduced the enabled features. I'm pretty sure this is a bug (on this line), but there is nothing that can be done in this PR.
opened by BD103 3
Taking breaks for more than 251 minutes by calling 'coffee_break!' multiple times
Despite there being some limits on break time, we can take a break for more than 251 minutes by calling coffee_break! multiple times.

Here is an example:

fn work_stuff() { // I can take breaks for 250 minutes × 100, close to 416 hours (seems like I cannot go home today) for n in 1..100 { coffee_break!(250 minutes); } }

I think we should save coffee-breaking logs as a file, in order to disallow taking breaks for multiple times.
opened by ActiveTK 1
Add features `ra-friendly` and `check-friendly` to make it friendlier
I love to take breaks, but not each time I ask rust-analyzer to complete something or when I run cargo check/clippy to find errors, so I added two optional features to make it friendlier to them.

ra-friendly for rust-analyzer

check-friendly for cargo check/clippy

[EDIT] I took two coffee breaks during this PR :coffee:
opened by v3rmine 0

Releases(2.1.1)

2.1.1(Apr 9, 2024)
This release contains the following improvements by these contributors:

BD103: Remove the quote dependency, making this crate faster to compile. Ironic. This is also technically a breaking change since the macro now emits nothing rather than an empty tuple.

joxcat: Make the library rust-analyzer friendly and friendly for cargo check. There are now two default features ra-friendly and check-friendly that add checks that don't activate the coffee break when we run in the context of rust-analyzer or when we aren't building respectively. This makes the crate not obliterate rust-analyzer when you add a coffee break and hit save, which is particurarly nice. With this change, you can realistically leave a coffee_break! in and continue working until you're ready to build and take a break.

Source code(tar.gz)
Source code(zip)
1.0.0(Mar 22, 2024)

Initial release
Source code(tar.gz)
Source code(zip)

Take a break while compiling.

Related tags

Overview

Coffee break

Overview

Example

Notes

Contributing

License

Contribution

You might also like...

Docker images for compiling static Rust binaries using musl-libc and musl-gcc, with static versions of useful C libraries. Supports openssl and diesel crates.

Docker images for compiling static Rust binaries using musl-cross

Everything you need to know about cross compiling Rust programs!

A collection of compilers based around compiling a high level language to a Brainfuck dialect.

Easy-to-use wrapper for WebRTC DataChannels peer-to-peer connections written in Rust and compiling to WASM.

MidenIR for compiling to Miden Assembly from higher-level languages

Rust library for compiling and running other programs.

A blazingly fast compiling & optimization tool for CosmWasm smart contracts.

Utilities for working with native solc and compiling projects.

MASQ combines the benefits of VPN and Tor technology to create a superior next-generation privacy software, where users are rewarded for supporting an uncensored global web. Users gain privacy and anonymity online, while helping promote Internet Freedom.

ripgrep recursively searches directories for a regex pattern while respecting your gitignore

A programming environment that aims to help people learn how to program in JavaScript, while giving them a tour on how old computers and their limitations used to be.

Midnote is a terminal application that reads a MIDI file and displays you its notes bar-by-bar, while playing it.

Collects accurate files while running in parallel through directories. (Simple, Fast, Powerful)

Auritia is a DAW coded in Rust and Vue in hopes of having cross platform compatability, while also providing enough features for anyone to use professionally

ripgrep recursively searches directories for a regex pattern while respecting your gitignore

A collection of algorithms that can do join between two parties while preserving the privacy of keys on which the join happens

handle some lichess.org/tournament load with rust, while learning rust

Canary - Distributed systems library for making communications through the network easier, while keeping minimalism and flexibility.

Comments

Remove `quote` dependency

Taking breaks for more than 251 minutes by calling 'coffee_break!' multiple times

Add features `ra-friendly` and `check-friendly` to make it friendlier

Releases(2.1.1)

2.1.1(Apr 9, 2024)

1.0.0(Mar 22, 2024)

Owner

Radek Vít

A simple CLI I made while practicing rust to easily make QR codes with just one command, all in your terminal.

Firefox used to have this feature a while back (from Firefox 11 to 46) and it is so good, that I feel it needs revival.

🍅 A command-line tool to get and set values in toml files while preserving comments and formatting

zkPoEX enables white hat hackers to report live vulnerabilities in smart contracts while maintaining the confidentiality of the exploit

A lightweight async Web crawler in Rust, optimized for concurrent scraping while respecting `robots.txt` rules.

BudouX-rs is a rust port of BudouX (machine learning powered line break organizer tool).

🔮 Futuristic take on hexdump, made in Rust.

Take your first step in writing a compiler. Implemented in Rust.

Take user input in Rust.

Mk48.io is an online multiplayer naval combat game, in which you take command of a ship and sail your way to victory