nav

Documentation

Index

• type DirState
  • func (d DirState) BackActive() bool
  • func (d DirState) Entries() []entry.Entry
  • func (d DirState) Error() error
  • func (d DirState) ForwardActive() bool
  • func (d DirState) UpActive() bool
• type Nav
  • func NewNav(showHidden bool, dirsMixed bool, startPath string, fsys afero.Fs, ...) *Nav
  • func (n *Nav) Back(currSelected []string, currCursor string) DirState
  • func (n *Nav) ClipboardCopy(selectedNames map[string]struct{}, cut bool)
  • func (n *Nav) CurrentPath() string
  • func (n *Nav) Delete(ctx context.Context, names []string) []error
  • func (n *Nav) Forward(currSelected []string, currCursor string) DirState
  • func (n *Nav) GetPreview(ctx context.Context, path string) entry.Preview
  • func (n *Nav) Go(path string, currCursor string, currSelected []string) DirState
  • func (n *Nav) MkDir(ctx context.Context, name string) []error
  • func (n *Nav) MkFile(ctx context.Context, name string) []error
  • func (n *Nav) Reload(currSelected []string, currCursor string) DirState
  • func (n *Nav) Rename(ctx context.Context, name, newName string) []error
  • func (n *Nav) SetDirsMixed(dirsMixed bool)
  • func (n *Nav) SetShowHidden(showHidden bool)
  • func (n *Nav) ShowHidden() bool
• type NavState
  • func (n NavState) Cursor() string
  • func (n NavState) Path() string
  • func (n NavState) Selected() map[string]struct{}
• type PreviewHandler
  • func NewPreviewHandler(ctx context.Context, previewDelay int, maxBytes int, cacheSize int, ...) *PreviewHandler
  • func (ph *PreviewHandler) GetPreview(ctx context.Context, fsys afero.Fs, path string) entry.Preview

Types

type DirState

type DirState struct {
	NavState
	// contains filtered or unexported fields
}

DirState represents the state of the directory

func (DirState) BackActive

func (d DirState) BackActive() bool

BackActive returns true if there is a back history

func (DirState) Entries

func (d DirState) Entries() []entry.Entry

Entries returns the directory entries

func (DirState) Error

func (d DirState) Error() error

Error returns the error or nil

func (DirState) ForwardActive

func (d DirState) ForwardActive() bool

ForwardActive returns true if there is a forward history

func (DirState) UpActive

func (d DirState) UpActive() bool

UpActive returns true if the current directory is not the root

type Nav

type Nav struct {
	// contains filtered or unexported fields
}

func NewNav

func NewNav(showHidden bool, dirsMixed bool, startPath string, fsys afero.Fs, previewDelay int, dryRun bool) *Nav

NewNav creates a new Nav struct. The startPath is the path to start the navigation at. The fsys is the filesystem to use. The previewDelay is the delay in milliseconds before previewing a file. If dryRun is true, no changes will be made to the filesystem.

func (*Nav) Back

func (n *Nav) Back(currSelected []string, currCursor string) DirState

Back moves back in the history stack and returns a DirState struct

func (*Nav) ClipboardCopy

func (n *Nav) ClipboardCopy(selectedNames map[string]struct{}, cut bool)

ClipboardCopy sets the internal clipboard to the selected entries

func (*Nav) CurrentPath

func (n *Nav) CurrentPath() string

CurrentPath returns the path to the current directory of the navigation instance.

func (*Nav) Delete

func (n *Nav) Delete(ctx context.Context, names []string) []error

Delete removes the files or directories with the given names from the current directory. If the Nav instance is in dry run mode, no files or directories will be removed. Returns a slice of errors encountered during the deletion process.

func (*Nav) Forward

func (n *Nav) Forward(currSelected []string, currCursor string) DirState

Forward moves forward in the history stack and returns a DirState struct

func (*Nav) GetPreview

func (n *Nav) GetPreview(ctx context.Context, path string) entry.Preview

GetPreview returns the preview for the file at the given path. The preview is generated using the Nav instance's PreviewHandler.

func (*Nav) Go

func (n *Nav) Go(path string, currCursor string, currSelected []string) DirState

Go changes the current directory to the given path and returns a Dirstate struct. If the path is "~", the home directory is used.

func (*Nav) MkDir

func (n *Nav) MkDir(ctx context.Context, name string) []error

MkDir creates a directory with the given name in the current directory. If the Nav instance is in dry run mode, no directory will be created. Returns a slice of errors encountered during the creation process.

func (*Nav) MkFile

func (n *Nav) MkFile(ctx context.Context, name string) []error

MkFile creates a file with the given name in the current directory. If the Nav instance is in dry run mode, no file will be created. Returns a slice of errors encountered during the creation process.

func (*Nav) Reload

func (n *Nav) Reload(currSelected []string, currCursor string) DirState

Reload reads and returns the current directory contents

func (*Nav) Rename

func (n *Nav) Rename(ctx context.Context, name, newName string) []error

Rename renames the file or directory with the given name to the given newName. If the Nav instance is in dry run mode, no files or directories will be renamed. Returns a slice of errors encountered during the rename process.

func (*Nav) SetDirsMixed

func (n *Nav) SetDirsMixed(dirsMixed bool)

func (*Nav) SetShowHidden

func (n *Nav) SetShowHidden(showHidden bool)

func (*Nav) ShowHidden

func (n *Nav) ShowHidden() bool

type NavState

type NavState struct {
	// contains filtered or unexported fields
}

NavState represents the state of the navigation within a directory

func (NavState) Cursor

func (n NavState) Cursor() string

Cursor returns the cursor in the directory

func (NavState) Path

func (n NavState) Path() string

Path returns the path to the directory of the NavState

func (NavState) Selected

func (n NavState) Selected() map[string]struct{}

Selected returns the selected items in the directory

type PreviewHandler

type PreviewHandler struct {
	// contains filtered or unexported fields
}

func NewPreviewHandler

func NewPreviewHandler(ctx context.Context, previewDelay int, maxBytes int, cacheSize int, pruneInterval time.Duration) *PreviewHandler

NewPreviewHandler creates a new PreviewHandler ctx is used to cancel periodic pruning of the cache previewDelay is the delay in milliseconds to wait before reading a file maxBytes is the maximum number of bytes to read from a file to form the preview cacheSize is the maximum number of previews to store in the cache pruneInterval is the interval at which to prune the cache

func (*PreviewHandler) GetPreview

func (ph *PreviewHandler) GetPreview(ctx context.Context, fsys afero.Fs, path string) entry.Preview