Listing Files and Directories in Go

PublishedDecember 6, 2018

•3 min read•View as Markdown

Srinivasan Rangarajan

Software Engineer with an entrepreneurship gene. Love talking about code, products, UI/UX and how to build startups.

Comments

Join the discussion

No comments yet. Be the first to comment.

More from this blog

Waiting for Goroutines to complete

Goroutines are one of the best features of Go language. It is very easy to run a function as a goroutine, you just have to use the keyword go before the function call. Here is a very simple function which sleeps for n seconds and prints a line. pa...

Dec 15, 20183 min read

String Replacements in Go

In a previous post, we saw how we can use Regular expressions in Go to match and replace patterns in a string. While regexps are very useful, you might not want to them for every time you want to do some basic string manipulation. The strings package...

Dec 14, 20182 min read

Creating errors in go

Go is a modern language, but doesn't use try-except blocks to handle errors. Errors are simple values that can be returned from functions and it is common to check for errors before proceeding with your next steps. Let's see the different ways to cre...

Dec 13, 20185 min read

How to write benchmarks in Go

In the previous post, we saw how to write a simple unit test case and also how to write table driven test cases. In this post we will quickly see how to write benchmarks, as go supports running benchmarks on your functions as part of the standard tes...

Dec 12, 20184 min read

Table Driven Unit Testing

Go has built-in support for writing test cases for your code. And it is important to write as much test cases as possible to make sure you cover all possible conditions. You have to use the testing standard package to write your unit test cases. Let...

Dec 11, 20183 min read

Pro Golang Dev

14 posts

Glob function

Go also has a Glob function which does exactly the same. Here is the signature of the function.

func Glob(pattern string) (matches []string, err error)

It takes a string containing the glob pattern and returns back a slice of filenames. Here is a sample program which gets all files ending with .jsonl extension in /data/ directory.

package main import ( "fmt" "path/filepath" ) func main() { matches, _ := filepath.Glob("/data/*.jsonl") for _, match := range matches { fmt.Println(match) } }

Walk

Glob is useful if you already know the pattern of the file you want to process. But if you want to go through every file and directory, filepath.Walk is a better approach.

Here is the signature of the Walk function.

func Walk(root string, walkFn WalkFunc) error

You start with a root directory from which you want to start the walk and for each file/directory in the root directory, the walkFn gets called. Now WalkFunc is a type of function which takes in the path, fileinfo and error and does something with the file that gets passed in.

type WalkFunc func(path string, info os.FileInfo, err error) error

This sounds complicated, but lets see a simple example to make things clear.

package main import ( "fmt" "os" "path/filepath" ) func WalkAllFilesInDir(dir string) error { return filepath.Walk(dir, func(path string, info os.FileInfo, e error) error { if e != nil { return e } // check if it is a regular file (not dir) if info.Mode().IsRegular() { fmt.Println("file name:", info.Name()) fmt.Println("file path:", path) } return nil }) } func main() { WalkAllFilesInDir("/home/username/go/src/github.com/") }

If you look at the main function, it is pretty simple - you just pass a directory to the WalkAllFilesInDir function. But WalkAlFilesInDir just calls the Walk function, with the dir string and an anonymous function of type WalkFunc.

As mentioned before, WalkFunc takes the path, info and an error parameter. First we check if there is any error. Then we use the info.Mode().IsRegular() to find if its a regular file or a directory. If it's a file, we just print the file name and the file path. Else, we skip to the next file.

The output looks something like this

file path: /home/username/go/src/github.com/uudashr/gopkgs/Makefile file name: README.md file path: /home/username/go/src/github.com/uudashr/gopkgs/README.md file name: main.go file path: /home/username/go/src/github.com/uudashr/gopkgs/cmd/gopkgs/main.go file name: doc.go

You can see that the Walk function goes through each and every subdirectory. This is an easy way to literally walk through all of your files and folders and process it.

These are the two popular functions I use to traverse files and directories. Do you have any other functions which does these better? Leave them in the comments below.

Command Palette

Comments

More from this blog

Glob function

Walk