Documentation
¶
Overview ¶
Package filecheck provides a means of checking that certain constraints apply to a file-system object. There are checks on the existence of the file and on it's status. The caller can opt to apply the checks to the object itself or, if it is a symbolic link, to the object being linked to. The default behaviour will check the status of the linked-to object.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( ErrShouldExistButDoesNot = errors.New("should exist but does not") ErrShouldNotExistButDoes = errors.New("should not exist but does") )
Functions ¶
This section is empty.
Types ¶
type Exists ¶
type Exists uint
Exists records whether the file-system object should exist or not. In each case the check is only valid at the time the check is made and so any code using this should be aware of this
type Provisos ¶
Provisos records the expectations of the file-system object. You can specify whether the object should or shouldn't exist and whether, if it's a symlink, you should follow the link. You can also perform a number of checks on the status of the file system object.
func DirExists ¶ added in v1.1.0
func DirExists() Provisos
DirExists returns a Provisos that will check that the value refers to a directory, which must exist. This is a common Provisos value and this func is provided to simplify your code.
func FileExists ¶ added in v1.1.0
func FileExists() Provisos
FileExists returns a Provisos that will check that the value refers to a regular file, which must exist. This is a common Provisos value and this func is provided to simplify your code.
func FileNonEmpty ¶ added in v1.1.0
func FileNonEmpty() Provisos
FileNonEmpty returns a Provisos that will check that the value refers to a regular file, which must exist and must not be empty. This is a common Provisos value and this func is provided to simplify your code.
func IsNew ¶ added in v1.1.0
func IsNew() Provisos
IsNew returns a Provisos that will check that the value refers to a non-existent file/directory. This is a common Provisos value and this func is provided to simplify your code.
func (Provisos) GetFileInfo ¶ added in v1.2.0
GetFileInfo gets the file information respecting the DontFollowSymlinks flag from the Provisos.
func (Provisos) StatusCheck ¶
StatusCheck checks that the file system object called 'name' satisfies the constraints. It returns a non-nil error if the constraint is not met. Note that if the file does not exist and it is not expected to exist then no further checks are performed (this may be obvious to you)
Source Files