kubernetes: k8s.io/kubernetes/pkg/util/filesystem Index | Files

package filesystem

import "k8s.io/kubernetes/pkg/util/filesystem"

Index

Package Files

defaultfs.go fakefs.go filesystem.go watcher.go

type DefaultFs Uses

type DefaultFs struct{}

DefaultFs implements Filesystem using same-named functions from "os" and "io/ioutil"

func (DefaultFs) Chtimes Uses

func (DefaultFs) Chtimes(name string, atime time.Time, mtime time.Time) error

Chtimes via os.Chtimes

func (DefaultFs) Create Uses

func (DefaultFs) Create(name string) (File, error)

Create via os.Create

func (DefaultFs) MkdirAll Uses

func (DefaultFs) MkdirAll(path string, perm os.FileMode) error

MkdirAll via os.MkdirAll

func (DefaultFs) ReadDir Uses

func (DefaultFs) ReadDir(dirname string) ([]os.FileInfo, error)

ReadDir via ioutil.ReadDir

func (DefaultFs) ReadFile Uses

func (DefaultFs) ReadFile(filename string) ([]byte, error)

ReadFile via ioutil.ReadFile

func (DefaultFs) Remove Uses

func (DefaultFs) Remove(name string) error

Remove via os.RemoveAll

func (DefaultFs) RemoveAll Uses

func (DefaultFs) RemoveAll(path string) error

RemoveAll via os.RemoveAll

func (DefaultFs) Rename Uses

func (DefaultFs) Rename(oldpath, newpath string) error

Rename via os.Rename

func (DefaultFs) Stat Uses

func (DefaultFs) Stat(name string) (os.FileInfo, error)

Stat via os.Stat

func (DefaultFs) TempDir Uses

func (DefaultFs) TempDir(dir, prefix string) (string, error)

TempDir via ioutil.TempDir

func (DefaultFs) TempFile Uses

func (DefaultFs) TempFile(dir, prefix string) (File, error)

TempFile via ioutil.TempFile

func (DefaultFs) Walk Uses

func (DefaultFs) Walk(root string, walkFn filepath.WalkFunc) error

Walk via filepath.Walk

type FSErrorHandler Uses

type FSErrorHandler func(err error)

FSErrorHandler is called when a fsnotify error occurs.

type FSEventHandler Uses

type FSEventHandler func(event fsnotify.Event)

FSEventHandler is called when a fsnotify event occurs.

type FSWatcher Uses

type FSWatcher interface {
    // Initializes the watcher with the given watch handlers.
    // Called before all other methods.
    Init(FSEventHandler, FSErrorHandler) error

    // Starts listening for events and errors.
    // When an event or error occurs, the corresponding handler is called.
    Run()

    // Add a filesystem path to watch
    AddWatch(path string) error
}

FSWatcher is a callback-based filesystem watcher abstraction for fsnotify.

func NewFsnotifyWatcher Uses

func NewFsnotifyWatcher() FSWatcher

NewFsnotifyWatcher returns an implementation of FSWatcher that continuously listens for fsnotify events and calls the event handler as soon as an event is received.

type File Uses

type File interface {
    // for now, the only os.File methods used are those below, add more as necessary
    Name() string
    Write(b []byte) (n int, err error)
    Sync() error
    Close() error
}

File is an interface that we can use to mock various filesystem operations typically accessed through the File object from the "os" package

type Filesystem Uses

type Filesystem interface {
    // from "os"
    Stat(name string) (os.FileInfo, error)
    Create(name string) (File, error)
    Rename(oldpath, newpath string) error
    MkdirAll(path string, perm os.FileMode) error
    Chtimes(name string, atime time.Time, mtime time.Time) error
    RemoveAll(path string) error
    Remove(name string) error

    // from "io/ioutil"
    ReadFile(filename string) ([]byte, error)
    TempDir(dir, prefix string) (string, error)
    TempFile(dir, prefix string) (File, error)
    ReadDir(dirname string) ([]os.FileInfo, error)
    Walk(root string, walkFn filepath.WalkFunc) error
}

Filesystem is an interface that we can use to mock various filesystem operations

func NewFakeFs Uses

func NewFakeFs() Filesystem

NewFakeFs returns a fake Filesystem that exists in-memory, useful for unit tests

Package filesystem imports 6 packages (graph) and is imported by 41 packages. Updated 2018-05-09. Refresh now. Tools for package owners.