osutil

Documentation

Overview

Package osutil implements utilities for native OS support.

Index

• Variables
• func Copy(filesystem fs.Filesystem, from, to string) (err error)
• func GetLans() ([]*net.IPNet, error)
• func GetLatencyForURL(addr string) (time.Duration, error)
• func HideConsole()
• func InWritableDir(fn func(string) error, fs fs.Filesystem, path string) error
• func IsWindowsExecutable(path string) bool
• func MaximizeOpenFileLimit() (int, error)
• func NativeFilename(s string) string
• func NormalizedFilename(s string) string
• func Rename(filesystem fs.Filesystem, from, to string) error
• func ResolveInterfaceAddresses(network, nameOrMac string) []string
• func TCPPing(address string) (time.Duration, error)
• func TempFile(filesystem fs.Filesystem, dir, prefix string) (f fs.File, err error)
• func TraversesSymlink(filesystem fs.Filesystem, name string) error
• func TryRename(filesystem fs.Filesystem, from, to string) error
• type AtomicWriter
  • func CreateAtomic(path string) (*AtomicWriter, error)
  • func CreateAtomicFilesystem(filesystem fs.Filesystem, path string) (*AtomicWriter, error)
  • func (w *AtomicWriter) Close() error
  • func (w *AtomicWriter) Write(bs []byte) (int, error)
• type NotADirectoryError
  • func (e NotADirectoryError) Error() string
• type ReplacingWriter
  • func (w ReplacingWriter) Write(bs []byte) (int, error)
• type TraversesSymlinkError
  • func (e TraversesSymlinkError) Error() string

Variables

var (
	ErrClosed  = errors.New("write to closed writer")
	TempPrefix = ".syncthing.tmp."
)

Functions

func Copy

func Copy(filesystem fs.Filesystem, from, to string) (err error)

Copy copies the file content from source to destination. Tries hard to succeed on various systems by temporarily tweaking directory permissions and removing the destination file when necessary.

func GetLans

func GetLans() ([]*net.IPNet, error)

func GetLatencyForURL

func GetLatencyForURL(addr string) (time.Duration, error)

GetLatencyForURL parses the given URL, tries opening a TCP connection to it and returns the time it took to establish the connection.

func HideConsole

func HideConsole()

func InWritableDir

func InWritableDir(fn func(string) error, fs fs.Filesystem, path string) error

InWritableDir calls fn(path), while making sure that the directory containing `path` is writable for the duration of the call.

func IsWindowsExecutable

func IsWindowsExecutable(path string) bool

IsWindowsExecutable returns true if the given path has an extension that is in the list of executable extensions.

func MaximizeOpenFileLimit

func MaximizeOpenFileLimit() (int, error)

MaximizeOpenFileLimit tries to set the resource limit RLIMIT_NOFILE (number of open file descriptors) to the max (hard limit), if the current (soft limit) is below the max. Returns the new (though possibly unchanged) limit, or an error if it could not be changed.

func NativeFilename

func NativeFilename(s string) string

func NormalizedFilename

func NormalizedFilename(s string) string

func Rename

func Rename(filesystem fs.Filesystem, from, to string) error

Rename moves a temporary file to it's final place. Will make sure to delete the from file if the operation fails, so use only for situations like committing a temp file to it's final location. Tries hard to succeed on various systems by temporarily tweaking directory permissions and removing the destination file when necessary.

func ResolveInterfaceAddresses

func ResolveInterfaceAddresses(network, nameOrMac string) []string

ResolveInterfaceAddresses returns available addresses of the given network type for a given interface.

func TCPPing

func TCPPing(address string) (time.Duration, error)

TCPPing returns the duration required to establish a TCP connection to the given host. ICMP packets require root privileges, hence why we use tcp.

func TempFile

func TempFile(filesystem fs.Filesystem, dir, prefix string) (f fs.File, err error)

TempFile creates a new temporary file in the directory dir with a name beginning with prefix, opens the file for reading and writing, and returns the resulting *os.File. If dir is the empty string, TempFile uses the default directory for temporary files (see os.TempDir). Multiple programs calling TempFile simultaneously will not choose the same file. The caller can use f.Name() to find the pathname of the file. It is the caller's responsibility to remove the file when no longer needed.

func TraversesSymlink

func TraversesSymlink(filesystem fs.Filesystem, name string) error

TraversesSymlink returns an error if base and any path component of name up to and including filepath.Join(base, name) traverses a symlink. Base and name must both be clean and name must be relative to base.

func TryRename

func TryRename(filesystem fs.Filesystem, from, to string) error

TryRename renames a file, leaving source file intact in case of failure. Tries hard to succeed on various systems by temporarily tweaking directory permissions and removing the destination file when necessary.

Types

type AtomicWriter

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

An AtomicWriter is an *os.File that writes to a temporary file in the same directory as the final path. On successful Close the file is renamed to it's final path. Any error on Write or during Close is accumulated and returned on Close, so a lazy user can ignore errors until Close.

func CreateAtomic

func CreateAtomic(path string) (*AtomicWriter, error)

CreateAtomic is like os.Create, except a temporary file name is used instead of the given name. The file is created with secure (0600) permissions.

func CreateAtomicFilesystem

func CreateAtomicFilesystem(filesystem fs.Filesystem, path string) (*AtomicWriter, error)

CreateAtomicFilesystem is like os.Create, except a temporary file name is used instead of the given name. The file is created with secure (0600) permissions.

func (*AtomicWriter) Close

func (w *AtomicWriter) Close() error

Close closes the temporary file and renames it to the final path. It is invalid to call Write() or Close() after Close().

func (*AtomicWriter) Write

func (w *AtomicWriter) Write(bs []byte) (int, error)

Write is like io.Writer, but is a no-op on an already failed AtomicWriter.

type NotADirectoryError

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

NotADirectoryError is an error indicating an expected path is not a directory

func (NotADirectoryError) Error

func (e NotADirectoryError) Error() string

type ReplacingWriter

type ReplacingWriter struct {
	Writer io.Writer
	From   byte
	To     []byte
}

func (ReplacingWriter) Write

func (w ReplacingWriter) Write(bs []byte) (int, error)

type TraversesSymlinkError

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

TraversesSymlinkError is an error indicating symlink traversal

func (TraversesSymlinkError) Error

func (e TraversesSymlinkError) Error() string