Skip to content
go-atomic-write

Installation

Requirements

Section titled “Requirements”
  • Go 1.26 or later
  • An active Go module (go.mod)

Install

Section titled “Install”

Run this in your project directory:

Terminal window
go get github.com/larsartmann/go-atomic-write@latest

Quick Usage

Section titled “Quick Usage”
package main


import (
  "errors"
  "fmt"


  atomicwrite "github.com/larsartmann/go-atomic-write"
)


func main() {
  path := "/path/to/config.json"


  fingerprint, err := atomicwrite.FingerprintFile(path)
  if err != nil {
    panic(err)
  }


  newData := []byte(`{"updated": true}`)


  err = atomicwrite.WriteVerified(path, newData, fingerprint)
  if errors.Is(err, atomicwrite.ErrConcurrentModification) {
    fmt.Println("file was modified concurrently — re-read and retry")
    return
  }
  if err != nil {
    panic(err)
  }
}

Verify Installation

Section titled “Verify Installation”
Terminal window
go list -m github.com/larsartmann/go-atomic-write

Next Steps

Section titled “Next Steps”