refactor: make RustScan additionally a library - #562
Merged
Conversation
PsypherPunk
commented
Apr 11, 2024
Collaborator
Author
|
Also, tests pass except that as this is now a library, doc-tests are running and failing. |
Owner
|
Wow this is cool!!!! A long awaited feature. I think some docs on how to use the library would be great too 🥳 |
- add `lib.rs` (permitted as per [_Packages and Crates_](https://doc.rust-lang.org/book/ch07-01-packages-and-crates.html)). - refactor `main.rs` to reference the library. - update module references as required.
PsypherPunk
force-pushed
the
497-rustscan-as-a-library
branch
from
April 12, 2024 09:10
b657479 to
994aff1
Compare
- fix some failing doc-tests. - amend formatting causing misinterpretation as code-samples. - mark some examples as [`compile_fail`](https://doc.rust-lang.org/rustdoc/write-documentation/documentation-tests.html#attributes) as there's no immediate way to instantiate the required `struct`.
PsypherPunk
force-pushed
the
497-rustscan-as-a-library
branch
from
April 12, 2024 09:22
994aff1 to
a5b50d9
Compare
Collaborator
Author
|
@bee-san, I've fixed the failing parts:
Re. the "docs on how to use the library", I'll see what I can do… |
- add lib-level docs. including a minimal example. - add minimal, headline information for each module.
PsypherPunk
marked this pull request as ready for review
April 12, 2024 14:04
bee-san
approved these changes
Apr 14, 2024
Owner
|
Wow! Thank you so much!! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
lib.rs(permitted as per Packages and Crates).main.rsto reference the library.relates #497
By way of example, configuring a new binary project which references this crate:
…allows
rustscanto be referenced as a library: