New collector DirectoryEntries

[Enselic]

The use case I have in mind is to add info about custom assets to bat. If we add this line to bat:

        .info(DirectoryEntries::new("Custom assets", PROJECT_DIRS.cache_dir()))

we will get output in --diagnostics that look like this if custom assets are installed:

#### Custom assets

- metadata.yaml, 101 bytes
- syntaxes.bin, 726517 bytes
- themes.bin, 40475 bytes

and like this

#### Custom assets

'/Users/martin/.cache/bat' not found

or this

#### Custom assets

'/Users/martin/.cache/bat' is empty

if no custom assets are installed.

I took some liberties in the structure and interface of the new collector.

• I put it in its own file to make it easier to work with
• I made the title owned rather than referenced so that e.g. a collector can be constructed in a helper function with the title from a local var in the function. See new_with_title_from_local_variable() example in tests. That code does not work for e.g. FileContents.
• I used the "impl trait" syntax for clarity

I still made the new collector appear in the right place in the module hierarchy though, as can be demonstrated with cargo public-items:

% cargo public-items | grep -e DirectoryEntries -e FileContent
 Documenting bugreport v0.4.1 (/Users/martin/src/bugreport)
    Finished dev [unoptimized + debuginfo] target(s) in 0.28s
pub fn bugreport::collector::DirectoryEntries::collect(&mut self, _: &CrateInfo<'_>) -> result::Result<ReportEntry, CollectionError>
pub fn bugreport::collector::DirectoryEntries::description(&self) -> &str
pub fn bugreport::collector::DirectoryEntries::new(title: impl Into<String>, path: impl Into<PathBuf>) -> Self
pub fn bugreport::collector::FileContent::collect(&mut self, _: &CrateInfo<'_>) -> result::Result<ReportEntry, CollectionError>
pub fn bugreport::collector::FileContent::description(&self) -> &str
pub fn bugreport::collector::FileContent::new<P: AsRef<Path>>(title: &'a str, path: P) -> Self
pub struct bugreport::collector::DirectoryEntries
pub struct bugreport::collector::FileContent<'a>

or just a quick look at the cargo doc HTML if you're old-school :)

This is pretty bare-bones in terms of functionality (see docs in the code for limitations and idea for future improvements) but it should suit the bat use case well.

[Enselic]

It would also be valuable to use FileContent on metadata.yaml in bat to get additional details about custom assets, but I would say there is some utility in this new collector too.

Btw, seems like CI has hanged, but that seems to be fixed by #12.

[sharkdp]

Thank you very much. This looks great!

[sharkdp]

Thank you. Let me know when/if I should release a new version in order to integrate this into bat.

[Enselic]

@sharkdp If you could make a release of bugreport when you get time that would be great. (I wanted to wait a bit to see if I could think of something else to do before a release but nothing has come to mind.)

[sharkdp]

Yes, of course: https://crates.io/crates/bugreport/0.5.0