Skip to content
This repository has been archived by the owner on Mar 29, 2023. It is now read-only.

Commit

Permalink
Improve Directory docs
Browse files Browse the repository at this point in the history
  • Loading branch information
magik6k committed Dec 12, 2018
1 parent 3196e3e commit 4db19d4
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions file.go
Original file line number Diff line number Diff line change
Expand Up @@ -78,17 +78,13 @@ type Directory interface {
// }
//
// Note:
// - Some implementations of this functions may define some constraints in how
// it can be used
// - Each implementation MUST support:
// - Pre-order sequential iteration:
// - Meaning that after calling `Next` you can call `Next` if the returned
// - After calling `Next` you can call `Next` if the returned
// node is a directory or read the returned file
// - Skipping entries:
// - Meaning that if `Next` returns a directory, you can skip reading it's
// entries and skip to next entry. Files don't have to be read in full.
// Note that you can't go back to unread entries, this only allows
// skipping parts of a directory tree
// - You can skip a file/directory by calling Next without reading it
// - You can't use skipped files/directories
// - This is to allow listing files in a directory without having to read
// the entire tree
// - Entries may not be sorted
Expand Down

0 comments on commit 4db19d4

Please sign in to comment.