Documentation
¶
Index ¶
- Constants
- func Write(fileMgr OSFileManager, file File) error
- type File
- type OSFileManager
- type StdLibOSFileManager
- func (s *StdLibOSFileManager) Chmod(file *os.File, mode os.FileMode) error
- func (s *StdLibOSFileManager) Copy(dst io.Writer, src io.Reader) error
- func (s *StdLibOSFileManager) Create(name string) (*os.File, error)
- func (s *StdLibOSFileManager) Open(name string) (*os.File, error)
- func (s *StdLibOSFileManager) ReadDir(dirname string) ([]fs.DirEntry, error)
- func (s *StdLibOSFileManager) Remove(name string) error
- func (s *StdLibOSFileManager) Write(file *os.File, contents []byte) error
- type Type
Constants ¶
View Source
const ( // RegularFileModeInt defines the default file mode for regular files as an integer. RegularFileModeInt = 0o644 // RegularFileMode defines the default file mode for regular files. RegularFileMode = "0644" // SecretFileMode defines the default file mode for files with secrets. SecretFileMode = "0640" )
Variables ¶
This section is empty.
Functions ¶
func Write ¶
func Write(fileMgr OSFileManager, file File) error
Types ¶
type OSFileManager ¶
type OSFileManager interface {
// Create file at the provided filepath.
Create(name string) (*os.File, error)
// Chmod sets the mode of the file.
Chmod(file *os.File, mode os.FileMode) error
// Write writes contents to the file.
Write(file *os.File, contents []byte) error
// Open opens the file.
Open(name string) (*os.File, error)
// Copy copies from src to dst.
Copy(dst io.Writer, src io.Reader) error
}
OSFileManager is an interface that exposes File I/O operations.
type StdLibOSFileManager ¶
type StdLibOSFileManager struct{}
StdLibOSFileManager wraps the standard library's file operations. Clients can define an interface with all or a subset StdLibOSFileManager methods and use it in their types or functions, so that they can be unit tested. It is expected that clients generate fakes.
func NewStdLibOSFileManager ¶
func NewStdLibOSFileManager() *StdLibOSFileManager
func (*StdLibOSFileManager) Create ¶
func (s *StdLibOSFileManager) Create(name string) (*os.File, error)
Create wraps os.Create.
func (*StdLibOSFileManager) Open ¶
func (s *StdLibOSFileManager) Open(name string) (*os.File, error)
Open wraps os.Open.
func (*StdLibOSFileManager) ReadDir ¶
func (s *StdLibOSFileManager) ReadDir(dirname string) ([]fs.DirEntry, error)
ReadDir wraps os.ReadDir.
func (*StdLibOSFileManager) Remove ¶
func (s *StdLibOSFileManager) Remove(name string) error
Remove wraps os.Remove.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.