Add Error docs to methods that return Result

[KodrAus]

Relevant API Guideline

Add an Errors section to methods that return Results:

• [x] Iter (for the Iterator::next() method)
• [x] IterFilterEntry (for the Iterator::next() method)
• [x] DirEntry::metadata()

[BurntSushi]

Done in #68