sequential

Documentation

Overview

Package sequential provides a set of functions for managing sequential files on Windows.

The origin of these functions are the golang OS and windows packages, slightly modified to only cope with files, not directories due to the specific use case.

The alteration is to allow a file on Windows to be opened with FILE_FLAG_SEQUENTIAL_SCAN (particular for docker load), to avoid eating the standby list, particularly when accessing large files such as layer.tar.

For non-Windows platforms, the package provides wrappers for the equivalents in the os packages. They are passthrough on Unix platforms, and only relevant on Windows.

Index

• func Create(name string) (*os.File, error)
• func CreateTemp(dir, prefix string) (f *os.File, err error)
• func Open(name string) (*os.File, error)
• func OpenFile(name string, flag int, perm os.FileMode) (*os.File, error)

Functions

func Create

func Create(name string) (*os.File, error)

Create is an alias for os.Create on non-Windows platforms.

func CreateTemp

func CreateTemp(dir, prefix string) (f *os.File, err error)

CreateTemp is an alias for os.CreateTemp on non-Windows platforms.

func Open

func Open(name string) (*os.File, error)

Open is an alias for os.Open on non-Windows platforms.

func OpenFile

func OpenFile(name string, flag int, perm os.FileMode) (*os.File, error)

OpenFile is an alias for os.OpenFile on non-Windows platforms.