file

Documentation

Overview

Package file implements utilities to read files from various backends.

Package file implements utilities to read files from various backends.

Index

• func ModTime(ctx context.Context, fname string) (time.Time, error)
• func ReadFile(ctx context.Context, fname string, readOptions ...ReadOption) ([]byte, error)
• func ReadWithCache(ctx context.Context, fname string, refreshInterval time.Duration, ...) ([]byte, error)
• type ReadOption
  • func WithEnvSubstitution() ReadOption

Functions

func ModTime

func ModTime(ctx context.Context, fname string) (time.Time, error)

ModTime returns file's modified timestamp.

func ReadFile

func ReadFile(ctx context.Context, fname string, readOptions ...ReadOption) ([]byte, error)

ReadFile returns file contents as a slice of bytes. It's similar to ioutil's ReadFile, but includes support for files on non-disk locations. For example, files with paths starting with gs:// are assumed to be on GCS, and are read from GCS.

func ReadWithCache

func ReadWithCache(ctx context.Context, fname string, refreshInterval time.Duration, readOptions ...ReadOption) ([]byte, error)

Types

type ReadOption

type ReadOption func(*readFileOpts)

func WithEnvSubstitution

func WithEnvSubstitution() ReadOption