fix_me

Crates.iofix_me
lib.rsfix_me
version0.1.2
sourcesrc
created_at2020-07-02 20:13:39.793926
updated_at2020-09-25 12:20:15.791443
descriptionA very simple macro that lets you write temporary code that WILL NOT build in release mode.
homepage
repositoryhttps://github.com/dylanfoxx/fix_me
max_upload_size
id260750
size5,289
Dylan Gebel (dylanfoxx)

documentation

README

Fix me is useful for writing temporary code that will be fixed later. It replaces comments like

//FIXME:Rework error handling 
or
//TODO:Add logging

Unlike comments fix_me is enforced by the compiler.

fix_me is a simple macro that lets you write temporary code that WILL NOT build in release mode.

  • You can still compile debug builds and run test --release without issue.
  • fix_me has no overhead on any release or debug code, instead it provides a compile error if any fix_me code is still in the project at release time.

Simple fix_me hello world

//Use on functions
fix_me::fix_me!(
	fn only_false() -> bool {
		use fix_me::fix_me;
		//Or in functions
		fix_me!(
		return true;
		);
	}
);

fn main() {
	match only_false() {
		false => println!("Hello"),
		_ => {}
	}       
}

It is recommended to add it to the dependencies as you are making changes then remove it as you finish your work.

Feature flag unfixed_code will allow you to compile release code even with fix_me still in your code base. A very simple macro that lets you write temporary code that WILL NOT build in release mode. You can still run debug and test --release without issue.

Commit count: 7

cargo fmt