Add a read only embedded FileSystem implementation backed by rust-embed #12
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
ahouts
commented
Oct 7, 2020
| @@ -9,4 +9,5 @@ matrix: | |||
| allow_failures: | |||
| - rust: nightly | |||
| - rust: beta | |||
| script: cargo build --verbose && cargo test --verbose | |||
| script: cargo build --verbose && cargo test --verbose && | |||
| cargo build --verbose --all-features && cargo test --verbose --all-features | |||
There was a problem hiding this comment.
Just to show the tests pass, not sure what approach you want to take for this.
ahouts
commented
Oct 7, 2020
| @@ -14,7 +14,11 @@ travis-ci = { repository = "manuel-woelker/rust-vfs", branch = "master" } | |||
|
|
|||
| [dependencies] | |||
| thiserror = "1.0" | |||
| rust-embed = { version = "5.6", optional = true } | |||
| radix_trie = { version = "0.1", optional = true } | |||
There was a problem hiding this comment.
Intentionally old version to support 1.32.0, the most recent version supports 1.36.0 due to a transient dependency on smallvec.
ahouts
commented
Oct 8, 2020
| fn child_elements<'a>( | ||
| d: &'a Path, | ||
| t: SubTrie<'a, String, bool>, | ||
| ) -> Box<dyn Iterator<Item = String> + 'a> { |
There was a problem hiding this comment.
If performance turns out to be an issue the dynamic iterator here could be replaced with an enum where each variant is one of the concrete types below.
|
Thanks for the PR! Should be great for fully self-contained executables. I imagine in some cases all the paths accessed in the embedded FS are known by the application anyway, so read_dir() and the supporting trie might not even be needed. |
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.
Adds a read only embedded
FileSystemimplementation backed by rust-embed.The API of rust-embed is very simplistic, so if we were to implement
FileSystem.read_dirwithout some kind of cache we would have to iterate through the entire directory listing every time. To prevent this I chose to use a radix trie to store the paths of files and directories whenEmbeddedFsis constructed.Both added dependencies are optional and gated behind a feature flag, so users who do not explicitly ask for embedded file system support will not need to download/compile them.