filelock

package

v0.3.1 Latest Latest Go to latest Published: Oct 28, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Details

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

Repository

github.com/anydoor7/tslink

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Package filelock provides cross-platform file locking.

Index ¶

func Lock(f *os.File) error
func TryLock(f *os.File) (bool, error)
func TryReadLock(f *os.File) (bool, error)
func Unlock(f *os.File) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Lock ¶

func Lock(f *os.File) error

Lock places an exclusive advisory lock on the given file. It blocks until the lock is acquired.

func TryLock ¶

func TryLock(f *os.File) (bool, error)

TryLock places an exclusive advisory lock on the given file without waiting. It reports false and a nil error when the lock is already held through another open file (another process, or another descriptor or handle of this one).

func TryReadLock ¶

func TryReadLock(f *os.File) (bool, error)

TryReadLock acquires a shared lock without waiting for a writer.

func Unlock ¶

func Unlock(f *os.File) error

Unlock releases the advisory lock on the given file.

Types ¶

This section is empty.

Source Files ¶

View all Source files

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