Skip to content

Commit 1ffedff

Browse files
committed
Make TopDir* functions experimental
They are not particularly useful in practice
1 parent d07f56a commit 1ffedff

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

fs.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -997,6 +997,8 @@ func PathContainsArchive(path string) bool {
997997
// an archive file or is an extracted archive file, as they will
998998
// work with the same filename/path inputs regardless of the
999999
// presence of a top-level directory.
1000+
//
1001+
// EXPERIMENTAL: Subject to change or removal even after stable release.
10001002
func TopDirOpen(fsys fs.FS, name string) (fs.File, error) {
10011003
file, err := fsys.Open(name)
10021004
if err == nil {
@@ -1006,6 +1008,8 @@ func TopDirOpen(fsys fs.FS, name string) (fs.File, error) {
10061008
}
10071009

10081010
// TopDirStat is like TopDirOpen but for Stat.
1011+
//
1012+
// EXPERIMENTAL: Subject to change or removal even after stable release.
10091013
func TopDirStat(fsys fs.FS, name string) (fs.FileInfo, error) {
10101014
info, err := fs.Stat(fsys, name)
10111015
if err == nil {
@@ -1015,6 +1019,8 @@ func TopDirStat(fsys fs.FS, name string) (fs.FileInfo, error) {
10151019
}
10161020

10171021
// TopDirReadDir is like TopDirOpen but for ReadDir.
1022+
//
1023+
// EXPERIMENTAL: Subject to change or removal even after stable release.
10181024
func TopDirReadDir(fsys fs.FS, name string) ([]fs.DirEntry, error) {
10191025
entries, err := fs.ReadDir(fsys, name)
10201026
if err == nil {

0 commit comments

Comments
 (0)