atomicfile

Documentation

Overview

Package atomicfile provides wrappers for atomically writing files in a manner compatible with long filenames.

Index

• func MaybePrefixLongFilenameOnWindows(fname string) string
• func Write(filename string, r io.Reader) error

Functions

func MaybePrefixLongFilenameOnWindows

func MaybePrefixLongFilenameOnWindows(fname string) string

MaybePrefixLongFilenameOnWindows prefixes the given filename with \\?\ on Windows if the filename is longer than 260 characters, which is required to be able to use some low-level Windows APIs. Because long file names have certain limitations: - we must replace forward slashes with backslashes. - dummy path element (\.\) must be removed.

Relative paths are always limited to a total of MAX_PATH characters: https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation

func Write

func Write(filename string, r io.Reader) error

Write is a wrapper around atomic.WriteFile that handles long file names on Windows.