dir

Documentation

Index

• Variables
• func AddSlash(entries []string) []string
• func Create(path string) error
• func Entries(path string) []string
• func EntriesWithSlash(path string) []string
• func Exists(path string) bool
• func HereOrAbove(name string) (string, error)
• func Name() string

Examples

• Entries
• Exists
• HereOrAbove (Above)
• HereOrAbove (Here)
• Name

Variables

var DefaultPerms = 0700

DefaultPerms are defaults for new directory creation.

Functions

func AddSlash

func AddSlash(entries []string) []string

AddSlash adds a filepath.Separator to the end of all entries passed that are directories.

func Create

func Create(path string) error

Create a new directory with the DefaultPerms creating any new directories as well (see os.MkdirAll)

func Entries

func Entries(path string) []string

In returns a slice of strings with all the files in the directory at that path joined to their path (as is usually wanted). Returns an empty slice if empty or path doesn't point to a directory. See List.

Example

package main

import (
	"fmt"

	"github.com/rwxrob/fs/dir"
)

func main() {
	list := dir.Entries("testdata")
	fmt.Println(list)
}

Output:

[testdata/adir testdata/file testdata/other]

func EntriesWithSlash

func EntriesWithSlash(path string) []string

EntriesWithSlash returns Entries passed to AddSlash so that all directories will have a trailing slash.

func Exists

func Exists(path string) bool

Exists calls fs.Exists and further confirms that the path is a directory and not a file.

Example

package main

import (
	"fmt"

	"github.com/rwxrob/fs/dir"
)

func main() {
	fmt.Println(dir.Exists("testdata/exists"))
	fmt.Println(dir.Exists("testdata"))
}

Output:

false
true

func HereOrAbove

func HereOrAbove(name string) (string, error)

HereOrAbove returns the full path to the dir if the dir is found in the current working directory, or if not exists in any parent directory recursively.

Example (Above)

package main

import (
	"fmt"
	"os"
	"path/filepath"
	"strings"

	"github.com/rwxrob/fs/dir"
)

func main() {
	_dir, _ := os.Getwd()
	defer func() { os.Chdir(_dir) }()
	os.Chdir("testdata/adir/anotherdir")

	path, err := dir.HereOrAbove("adir")
	if err != nil {
		fmt.Println(err)
	}
	d := strings.Split(path, string(filepath.Separator))
	fmt.Println(d[len(d)-2:])

}

Output:

[testdata adir]

Example (Here)

package main

import (
	"fmt"
	"os"
	"path/filepath"
	"strings"

	"github.com/rwxrob/fs/dir"
)

func main() {
	_dir, _ := os.Getwd()
	defer func() { os.Chdir(_dir) }()
	os.Chdir("testdata/adir")

	path, err := dir.HereOrAbove("anotherdir")
	if err != nil {
		fmt.Println(err)
	}
	d := strings.Split(path, string(filepath.Separator))
	fmt.Println(d[len(d)-2:])

}

Output:

[adir anotherdir]

func Name

func Name() string

Name returns the current working directory name or an empty string.

Example

package main

import (
	"fmt"
	"os"

	"github.com/rwxrob/fs/dir"
)

func main() {
	os.Chdir(`testdata`)
	fmt.Println(dir.Name())
	os.Chdir(`..`)
}

Output:

testdata