Skip to content

Commit

Permalink
Move generated files to target/generated/bincode (#600)
Browse files Browse the repository at this point in the history
  • Loading branch information
trevyn authored Nov 3, 2022
1 parent 0c0a1f2 commit ba4d196
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion derive/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ description = "Implementation of #[derive(Encode, Decode)] for bincode"
proc-macro = true

[dependencies]
virtue = "0.0.10"
virtue = "0.0.11"
2 changes: 1 addition & 1 deletion derive/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ This is supported by the structs in `src/generate`. The most notable points of t

For additional derive testing, see the test cases in `../tests`

For testing purposes, all generated code is outputted to the current `target` folder, under file name `<struct/enum name>_Encode.rs` and `<struct/enum name>_Decode.rs`. This can help with debugging.
For testing purposes, all generated code is outputted to the current `target/generated/bincode` folder, under file name `<struct/enum name>_Encode.rs` and `<struct/enum name>_Decode.rs`. This can help with debugging.
6 changes: 3 additions & 3 deletions derive/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ fn derive_encode_inner(input: TokenStream) -> Result<TokenStream> {
}
}

generator.export_to_file("Encode");
generator.export_to_file("bincode", "Encode");
generator.finish()
}

Expand Down Expand Up @@ -67,7 +67,7 @@ fn derive_decode_inner(input: TokenStream) -> Result<TokenStream> {
}
}

generator.export_to_file("Decode");
generator.export_to_file("bincode", "Decode");
generator.finish()
}

Expand Down Expand Up @@ -100,6 +100,6 @@ fn derive_borrow_decode_inner(input: TokenStream) -> Result<TokenStream> {
}
}

generator.export_to_file("BorrowDecode");
generator.export_to_file("bincode", "BorrowDecode");
generator.finish()
}
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,4 @@ Bincode will encode enum variants as a `u32`. If you're worried about storage si

Currently we have not found a compelling case to respect `#[repr(...)]`. You're most likely trying to interop with a format that is similar-but-not-quite-bincode. We only support our own protocol ([spec](https://github.com/bincode-org/bincode/blob/trunk/docs/spec.md)).

If you really want to use bincode to encode/decode a different protocol, consider implementing `Encode` and `Decode` yourself. `bincode-derive` will output the generated implementation in `target/<name>_Encode.rs` and `target/<name>_Decode.rs` which should get you started.
If you really want to use bincode to encode/decode a different protocol, consider implementing `Encode` and `Decode` yourself. `bincode-derive` will output the generated implementation in `target/generated/bincode/<name>_Encode.rs` and `target/generated/bincode/<name>_Decode.rs` which should get you started.
2 changes: 1 addition & 1 deletion src/de/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ pub use self::decoder::DecoderImpl;
///
/// # Implementing this trait manually
///
/// If you want to implement this trait for your type, the easiest way is to add a `#[derive(bincode::Decode)]`, build and check your `target/` folder. This should generate a `<Struct name>_Decode.rs` file.
/// If you want to implement this trait for your type, the easiest way is to add a `#[derive(bincode::Decode)]`, build and check your `target/generated/bincode/` folder. This should generate a `<Struct name>_Decode.rs` file.
///
/// For this struct:
///
Expand Down
2 changes: 1 addition & 1 deletion src/enc/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pub use self::encoder::EncoderImpl;
///
/// # Implementing this trait manually
///
/// If you want to implement this trait for your type, the easiest way is to add a `#[derive(bincode::Encode)]`, build and check your `target/` folder. This should generate a `<Struct name>_Encode.rs` file.
/// If you want to implement this trait for your type, the easiest way is to add a `#[derive(bincode::Encode)]`, build and check your `target/generated/bincode/` folder. This should generate a `<Struct name>_Encode.rs` file.
///
/// For this struct:
///
Expand Down

0 comments on commit ba4d196

Please sign in to comment.