file

Documentation

Index

• func CloseFile(f *os.File)
• func CreateEmptyIfNotExists(filename string)
• func Exists(filename string) (exists bool)
• func GetContents(filename string) string
• func Initialize(errorHandler func(err error), traceHandler func(format string, a ...any))
• func OpenFile(filename string) *os.File
• func Remove(filename string)
• func WriteString(f *os.File, s string)

Examples

• CreateEmptyIfNotExists

Functions

func CloseFile

func CloseFile(f *os.File)

func CreateEmptyIfNotExists

func CreateEmptyIfNotExists(filename string)

CreateEmptyIfNotExists creates an empty file with the given filename if it does not already exist. If the parent directory of the file does not exist, the function will create it. The function is useful for ensuring that a file is present before writing to it.

Example

package main

import (
	"github.com/microsoft/go-sqlcmd/internal/io/file"
	"os"
	"path/filepath"
)

func main() {
	filename := filepath.Join(os.TempDir(), "foo.txt")

	file.CreateEmptyIfNotExists(filename)
}

func Exists

func Exists(filename string) (exists bool)

Exists checks if a file with the given filename exists in the file system. It returns a boolean value indicating whether the file exists or not.

func GetContents

func GetContents(filename string) string

func Initialize

func Initialize(
	errorHandler func(err error),
	traceHandler func(format string, a ...any))

func OpenFile

func OpenFile(filename string) *os.File

func Remove

func Remove(filename string)

Remove is used to remove a file with the specified filename. The function takes in the name of the file as an argument and deletes it from the file system.

func WriteString

func WriteString(f *os.File, s string)