ignorefs

Documentation

Overview

Package ignorefs implements a wrapper that hides ignored files listed in '.kopiaignore' and in policies attached to directories.

Index

• func New(dir fs.Directory, policyTree *policy.Tree, options ...Option) fs.Directory
• type IgnoreCallback
• type Option
  • func ReportIgnoredFiles(f IgnoreCallback) Option

Functions

func New

func New(dir fs.Directory, policyTree *policy.Tree, options ...Option) fs.Directory

New returns a fs.Directory that wraps another fs.Directory and hides files specified in the ignore dotfiles.

Types

type IgnoreCallback

type IgnoreCallback func(ctx context.Context, path string, metadata fs.Entry, pol *policy.Tree)

IgnoreCallback is a function called by ignorefs to report whenever a file or directory is being ignored while listing its parent.

type Option

type Option func(parentContext *ignoreContext)

Option modifies the behavior of ignorefs.

func ReportIgnoredFiles

func ReportIgnoredFiles(f IgnoreCallback) Option

ReportIgnoredFiles returns an Option causing ignorefs to call the provided function whenever a file or directory is ignored.