static_web_server crate
#190
Merged
Conversation
This file contains 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
joseluisq
added
enhancement
joseluisq
force-pushed
the
feature/static_web_server_cargo_crate
branch
from
01e9dee to
fb83efa
Compare
joseluisq
force-pushed
the
feature/static_web_server_cargo_crate
branch
from
fb83efa to
34495bb
Compare
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.
Description
This PR prepares the project to be ready to publish to crates.io as a library.
Considerations:
The crate should be published to make it possible for users to embed SWS with ease instead of working around it via forks. For example, allowing users to turn off default features like
tlsand so on.However, because the library is highly coupled with the SWS binary project at this point, users might be limited by the exposed APIs, implementations, missing functionality, or dependencies.
In the future, we will eventually plan to make SWS library independent from the binary project.
That said, if fine-grained control and flexibility are needed then users could want to look at other alternatives like HTTP libraries or frameworks.
Building the docs
If you want to look at the
static_web_servercrate docs API locally, clone the repository, typecargo doc --openon your terminal, and navigate to your browser.Related Issue
Motivation and Context
Resolves #188
How Has This Been Tested?
Screenshots (if appropriate):