flock

Documentation

Overview

Package flock provides a wrapper around syscall.Flock

Index

• Constants
• type Flock
  • func Lock(filename string) (*Flock, error)
  • func New(filename string) *Flock
  • func NewWithOpener(filename string, opener OpenerFunc) *Flock
  • func (lock *Flock) Lock() error
  • func (lock *Flock) Unlock()
• type Handle
• type OpenerFunc
• type Options
  • func (opt Options) JoinName(name string) string
  • func (opt Options) Mkdir(name string, dmode fs.FileMode) error
  • func (opt Options) MkdirAll(name string, dmode fs.FileMode) error
  • func (opt Options) MkdirBase(dmode fs.FileMode) error
  • func (opt Options) NameSplit(name string) (string, string)
  • func (opt Options) New(name string, perm fs.FileMode) (*Flock, error)
  • func (opt Options) NewOpener(perm fs.FileMode) func(string) (Handle, error)
  • func (opt Options) ReadDir(name string) ([]fs.DirEntry, error)
  • func (opt Options) ReadFile(name string, perm fs.FileMode) ([]byte, error)
  • func (opt Options) WriteFile(name string, data []byte, perm fs.FileMode) error

Constants

const (
	// DefaultFileMode is the filemode used when a flock file is first created
	DefaultFileMode = 0666
	// DefaultDirMode is the filemode used when a directory is created
	DefaultDirMode = 0777
)

Types

type Flock

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

Flock implements a simple wrapper around syscall.Flock

func Lock

func Lock(filename string) (*Flock, error)

Lock flocks a file by name

func New

func New(filename string) *Flock

New instantiates a Flock for a given filename

func NewWithOpener

func NewWithOpener(filename string, opener OpenerFunc) *Flock

NewWithOpener instantiates a Flock for a given filename

func (*Flock) Lock

func (lock *Flock) Lock() error

Lock Flocks the file

func (*Flock) Unlock

func (lock *Flock) Unlock()

Unlock releases the flock

type Handle

type Handle = fssyscall.Handle

Handle is a OS-agnostic syscall handler

type OpenerFunc

type OpenerFunc func(string) (Handle, error)

OpenerFunc is a function that opens a file

type Options

type Options struct {
	Base    string      // optional prefix
	Create  bool        // create nodes if missing
	DirMode fs.FileMode // mode used for MkdirAll
}

Options provides rules for Flock protected actions

func (Options) JoinName

func (opt Options) JoinName(name string) string

JoinName joins the given name with the Options.Base when not qualified

func (Options) Mkdir

func (opt Options) Mkdir(name string, dmode fs.FileMode) error

Mkdir creates a directory within the base

func (Options) MkdirAll

func (opt Options) MkdirAll(name string, dmode fs.FileMode) error

MkdirAll attempts to create all directories on a path within the base

func (Options) MkdirBase

func (opt Options) MkdirBase(dmode fs.FileMode) error

MkdirBase creates the Options.Base if it doesn't exist

func (Options) NameSplit

func (opt Options) NameSplit(name string) (string, string)

NameSplit considers Options.Base when splitting a given path

func (Options) New

func (opt Options) New(name string, perm fs.FileMode) (*Flock, error)

New creates a new Flock considering Options

func (Options) NewOpener

func (opt Options) NewOpener(perm fs.FileMode) func(string) (Handle, error)

NewOpener creates an opener funcion considering Options.Create and the given permissions

func (Options) ReadDir

func (opt Options) ReadDir(name string) ([]fs.DirEntry, error)

ReadDir reads the entries of a directory, flocked

func (Options) ReadFile

func (opt Options) ReadFile(name string, perm fs.FileMode) ([]byte, error)

ReadFile reads a file whole, flocked

func (Options) WriteFile

func (opt Options) WriteFile(name string, data []byte, perm fs.FileMode) error

WriteFile writes the given content to a locked file