filelock

package module

v0.81.0 Latest Latest Go to latest Published: Sep 16, 2026 License: Apache-2.0 Imports: 5 Imported by: 27

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cloudfoundry/filelock

Links

Open Source Insights

README ¶

filelock

This library will allow locking a file for synchronous operation.

[!NOTE]

This repository should be imported as code.cloudfoundry.org/filelock.

Contributing

See the Contributing.md for more information on how to contribute.

Working Group Charter

This repository is maintained by App Runtime Platform under Garden Containers area.

[!IMPORTANT]

Content in this file is managed by the CI task sync-readme and is generated by CI following a convention.

Documentation ¶

Rendered for

Index ¶

type FileLocker
- func NewLocker(path string) FileLocker
type LockedFile
type Locker
- func (l *Locker) Lock() error
- func (l *Locker) Unlock() error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type FileLocker ¶

type FileLocker interface {
	Open() (LockedFile, error)
}

func NewLocker ¶

func NewLocker(path string) FileLocker

type LockedFile ¶

type LockedFile interface {
	Close() error
	Read([]byte) (int, error)
	Truncate(int64) error
	Write([]byte) (int, error)
	Seek(int64, int) (int64, error)
}

type Locker ¶

type Locker struct {
	FileLocker FileLocker
	Mutex      *sync.Mutex
	// contains filtered or unexported fields
}

func (*Locker) Lock ¶

func (l *Locker) Lock() error

func (*Locker) Unlock ¶

func (l *Locker) Unlock() error

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
fakes Code generated by counterfeiter.	Code generated by counterfeiter.
filelock-demo
filelockfakes Code generated by counterfeiter.	Code generated by counterfeiter.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL