file

Documentation

Index

• Constants
• Variables
• func Exists(path string) bool
• func LockFilePath(path string) string
• func NewForcedUnlockError(errs []error) error
• func NewIOError(message string) error
• func NewLockError(message string) error
• func NewTimeoutError(path string) error
• func ParseError(err error) error
• func TempFilePath(path string) string
• func UnlockAll() error
• func UnlockAllWithErrors() error
• func UpdateWaitTimeout(waitTimeout float64, retryInterval time.Duration)
• type ForcedUnlockError
  • func (e ForcedUnlockError) Error() string
• type Handler
  • func NewHandlerForCreate(path string) (*Handler, error)
  • func NewHandlerForRead(path string) (*Handler, error)
  • func NewHandlerForUpdate(path string) (*Handler, error)
  • func (h *Handler) Close() error
  • func (h *Handler) CloseWithErrors() error
  • func (h *Handler) Commit() error
  • func (h *Handler) FileForRead() *os.File
  • func (h *Handler) FileForUpdate() *os.File
  • func (h *Handler) Path() string
  • func (h *Handler) PrepareToRead() error
  • func (h *Handler) TryCreateLockFile() error
  • func (h *Handler) TryCreateLockFileWithTimeout() error
  • func (h *Handler) TryCreateTempFile() error
• type IOError
  • func (e IOError) Error() string
• type LockError
  • func (e LockError) Error() string
• type OpenType
• type TimeoutError
  • func (e TimeoutError) Error() string

Constants

const (
	LockFileSuffix = ".lock"
	TempFileSuffix = ".temp"
)

Variables

var RetryInterval = 50 * time.Millisecond

var WaitTimeout = 30.0

Functions

func Exists

func Exists(path string) bool

func LockFilePath

func LockFilePath(path string) string

func NewForcedUnlockError

func NewForcedUnlockError(errs []error) error

func NewIOError

func NewIOError(message string) error

func NewLockError

func NewLockError(message string) error

func NewTimeoutError

func NewTimeoutError(path string) error

func ParseError

func ParseError(err error) error

func TempFilePath

func TempFilePath(path string) string

func UnlockAll

func UnlockAll() error

func UnlockAllWithErrors

func UnlockAllWithErrors() error

func UpdateWaitTimeout

func UpdateWaitTimeout(waitTimeout float64, retryInterval time.Duration)

Types

type ForcedUnlockError

type ForcedUnlockError struct {
	Errors []error
}

func (ForcedUnlockError) Error

func (e ForcedUnlockError) Error() string

type Handler

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

func NewHandlerForCreate

func NewHandlerForCreate(path string) (*Handler, error)

func NewHandlerForRead

func NewHandlerForRead(path string) (*Handler, error)

func NewHandlerForUpdate

func NewHandlerForUpdate(path string) (*Handler, error)

func (*Handler) Close

func (h *Handler) Close() error

func (*Handler) CloseWithErrors

func (h *Handler) CloseWithErrors() error

func (*Handler) Commit

func (h *Handler) Commit() error

func (*Handler) FileForRead

func (h *Handler) FileForRead() *os.File

func (*Handler) FileForUpdate

func (h *Handler) FileForUpdate() *os.File

func (*Handler) Path

func (h *Handler) Path() string

func (*Handler) PrepareToRead

func (h *Handler) PrepareToRead() error

func (*Handler) TryCreateLockFile

func (h *Handler) TryCreateLockFile() error

func (*Handler) TryCreateLockFileWithTimeout

func (h *Handler) TryCreateLockFileWithTimeout() error

func (*Handler) TryCreateTempFile

func (h *Handler) TryCreateTempFile() error

type IOError

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

func (IOError) Error

func (e IOError) Error() string

type LockError

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

func (LockError) Error

func (e LockError) Error() string

type OpenType

type OpenType int

const (
	ForRead OpenType = iota
	ForCreate
	ForUpdate
)

type TimeoutError

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

func (TimeoutError) Error

func (e TimeoutError) Error() string