localfs

Documentation

Overview

Package localfs implements virtual filesystem abstraction for a local filesystem.

Index

• Constants
• func Directory(path string) (fs.Directory, error)
• func NewEntry(path string) (fs.Entry, error)
• func TrimShallowSuffix(path string) string
• func WriteShallowPlaceholder(path string, de *snapshot.DirEntry) (string, error)
• type PlaceholderFilePath
  • func (pf PlaceholderFilePath) DirEntryOrNil(ctx context.Context) (*snapshot.DirEntry, error)

Constants

const (
	// ShallowEntrySuffix is a suffix identifying placeholder files.
	ShallowEntrySuffix = ".kopia-entry"
)

Functions

func Directory

func Directory(path string) (fs.Directory, error)

Directory returns fs.Directory for the specified path.

func NewEntry

func NewEntry(path string) (fs.Entry, error)

NewEntry returns fs.Entry for the specified path, the result will be one of supported entry types: fs.File, fs.Directory, fs.Symlink or fs.UnsupportedEntry.

func TrimShallowSuffix

func TrimShallowSuffix(path string) string

TrimShallowSuffix returns the path without the placeholder suffix.

func WriteShallowPlaceholder

func WriteShallowPlaceholder(path string, de *snapshot.DirEntry) (string, error)

WriteShallowPlaceholder writes sufficient metadata into the placeholder file associated with path so that it can be roundtripped through snapshot/restore without needing to be realized in the local filesystem. TODO(rjk): Should the placeholder use the complete fs.Entry?

Types

type PlaceholderFilePath

type PlaceholderFilePath string

PlaceholderFilePath is a filesystem path of a shallow placeholder file or directory.

func (PlaceholderFilePath) DirEntryOrNil

func (pf PlaceholderFilePath) DirEntryOrNil(ctx context.Context) (*snapshot.DirEntry, error)

DirEntryOrNil returns the snapshot.DirEntry corresponding to this PlaceholderFilePath.