PoC: add RepositoryPathBuf #1921
Conversation
There was a problem hiding this comment.
Thanks for getting this started.
Besides my notes, one key aspect of it is that there is a &RepositoryPath that only exists as reference, similar to PathBuf/&Path. An example for this is gix-ref::FileName|&FileNameRef, it needs some unsafe to do the conversion.
Finally, there must be an std::str::from_utf8_unchecked() equivalent for APIs that only have a single component, for example, or do their own validation naturally as part of the parsing.
This leads me to an interesting observation: gix_object::Tree::entries actually only has a RepositoryPathComponent, which might be a type we want explicitly just to say it's definitely not having slashes in there.
And with all this as a start, I think it will come together naturally.
| } | ||
| } | ||
|
|
||
| impl std::ops::Deref for RepositoryPathPuf { |
There was a problem hiding this comment.
The idea would be to avoid having easy conversions to BString and treat it as distinct type with its own PathBuf-like API.
There was a problem hiding this comment.
Absolutely! This was just a shortcut to get this first addition to compile with the least amount of changes possible (I should have been more clear about the context and the status of this initial commit).
A more general question: is the idea to have both the new types backed by inner: BString (and inner: &BStr) or rather by inner: Vec<u8> (and inner: &[u8])? If the latter, we would need to implement all the necessary functions that are currently provided by BString (and &BStr) ourselves, or am I missing something?
There was a problem hiding this comment.
The path of least resistance (and the preferred one) should be to let it be backed by BString|&BStr. Maybe this will also be a great preparation for the time when std::…::ByteString can be used, when only the backing needs to be adjusted as most code is using RepositoryPathComponent|RepositoryPathBuf and friends.
| } | ||
| } | ||
|
|
||
| impl From<BString> for RepositoryPathPuf { |
There was a problem hiding this comment.
There should be no API that converts to this type without checking the input - paths now have to be relative.
| @@ -249,14 +249,57 @@ impl Ord for EntryRef<'_> { | |||
| } | |||
| } | |||
|
|
|||
| /// TODO | |||
| /// Keep in mind that the path separator always is `/`, independent of the platform. | |||
There was a problem hiding this comment.
And on top of that, it's a relative path with only Normal path components. Also it's always represented as bunch of bytes.
This is a PoC that adds
RepositoryPathBufingix_object::tree, for initial use ingix_object::tree::Entry. It is intended to make sure I start making the right changes in the right places.This PR adds
RepositoryPathBufand uses it forgix_object::tree::Entry::filename. I adapted other places in the code until I gotjust checkpassing.