dirwalk

Documentation

Overview

Package dirwalk contains code to walk a directory.

Index

• func WalkShallow(dirName mem.RO, fn WalkFunc) error
• type WalkFunc

Functions

func WalkShallow

func WalkShallow(dirName mem.RO, fn WalkFunc) error

WalkShallow reads the entries in the named directory and calls fn for each. It does not recurse into subdirectories.

If fn returns an error, iteration stops and WalkShallow returns that value.

On Linux, WalkShallow does not allocate, so long as certain methods on the WalkFunc's DirEntry are not called which necessarily allocate.

Types

type WalkFunc

type WalkFunc func(name mem.RO, de fs.DirEntry) error

WalkFunc is the callback type used with WalkShallow.

The name and de are only valid for the duration of func's call and should not be retained.