package fs

Import Path
	github.com/kr/fs (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package


Involved Source Files

	    filesystem.go
	
		Package fs provides filesystem-related functions.


Code Examples

	
		package main
		
		import (
			"fmt"
			"os"
		
			"github.com/kr/fs"
		)
		
		func main() {
			walker := fs.Walk("/usr/lib")
			for walker.Step() {
				if err := walker.Err(); err != nil {
					fmt.Fprintln(os.Stderr, err)
					continue
				}
				fmt.Println(walker.Path())
			}
		}




Package-Level Type Names (total 2)


	/* sort by:  |  */
	
		FileSystem defines the methods of an abstract filesystem.

		
			
				Join joins any number of path elements into a single path, adding a
				separator if necessary. The result is Cleaned; in particular, all
				empty strings are ignored.
				
				The separator is FileSystem specific.

			
				Lstat returns a FileInfo describing the named file. If the file is a
				symbolic link, the returned FileInfo describes the symbolic link. Lstat
				makes no attempt to follow the link.

			
				ReadDir reads the directory named by dirname and returns a
				list of directory entries.

		
			*github.com/pkg/sftp.Client
		
			func WalkFS(root string, fs FileSystem) *Walker


	
		Walker provides a convenient interface for iterating over the
		descendants of a filesystem path.
		Successive calls to the Step method will step through each
		file or directory in the tree, including the root. The files
		are walked in lexical order, which makes the output deterministic
		but means that for very large directories Walker can be inefficient.
		Walker does not follow symbolic links.

		
			
				Err returns the error, if any, for the most recent attempt
				by Step to visit a file or directory. If a directory has
				an error, w will not descend into that directory.

			
				Path returns the path to the most recent file or directory
				visited by a call to Step. It contains the argument to Walk
				as a prefix; that is, if Walk is called with "dir", which is
				a directory containing the file "a", Path will return "dir/a".

			
				SkipDir causes the currently visited directory to be skipped.
				If w is not on a directory, SkipDir has no effect.

			
				Stat returns info for the most recent file or directory
				visited by a call to Step.

			
				Step advances the Walker to the next file or directory,
				which will then be available through the Path, Stat,
				and Err methods.
				It returns false when the walk stops at the end of the tree.

		
			func Walk(root string) *Walker
			func WalkFS(root string, fs FileSystem) *Walker
			func github.com/pkg/sftp.(*Client).Walk(root string) *Walker




Package-Level Functions (total 2)


	
		Walk returns a new Walker rooted at root.


	
		WalkFS returns a new Walker rooted at root on the FileSystem fs.