Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

flock

package module

Go to main page

Versions in this module

v1

v1.2.0

Oct 27, 2026

Changes in this version

+ var ErrAlreadyClosed = errors.New("file is already closed")

type Lock

+ func (l *Lock) IsClosed() bool

+ func (l *Lock) IsOpen() bool

+ type State uint8

+ const Borrowed

+ const Closed

+ const Init

+ const Invalid

+ const Owned

+ func (t State) String() string

v1.1.0

Aug 4, 2026

Changes in this version

type Option

+ func WithPathAt(param int) Option

v1.0.0

Apr 12, 2026

Changes in this version

+ const SEEK_CUR

+ const SEEK_END

+ const SEEK_SET

+ var ErrAlreadyOpen error = errors.New("file is already open")

+ var ErrUnsupported error = errors.New("range locks not supported by OS") — darwin/amd64, js/wasm, windows/amd64

+ type Lock struct

+ func New(opt ...Option) *Lock

+ func (l *Lock) Close() error

+ func (l *Lock) Fd() int

+ func (l *Lock) File() *os.File

+ func (l *Lock) LockEx() error

+ func (l *Lock) LockRangeEx(start, len int64, whence ...int16) error

+ func (l *Lock) LockRangeSh(start, len int64, whence ...int16) error

+ func (l *Lock) LockSh() error

+ func (l *Lock) Open() error

+ func (l *Lock) OwningFd() bool

+ func (l *Lock) Path() string

+ func (l *Lock) TryLockEx() error

+ func (l *Lock) TryLockRangeEx(start, len int64, whence ...int16) error

+ func (l *Lock) TryLockRangeSh(start, len int64, whence ...int16) error

+ func (l *Lock) TryLockSh() error

+ func (l *Lock) Unlock() error

+ func (l *Lock) UnlockRange(start, len int64, whence ...int16) error

+ type Option func(*opts)

+ func WithAppend() Option

+ func WithCloseOnExec() Option

+ func WithCreate(perms ...uint32) Option

+ func WithFd(param int) Option

+ func WithIsDir() Option

+ func WithPath(param string) Option

+ func WithRdWr() Option

+ func WithTruncate() Option

+ func WithWrOnly() Option

+ func WithoutIntrRetry() Option