fileio

package
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 25, 2024 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Overview

Package fileio is a generated GoMock package.

Index

Constants

View Source 
const (

	// defaultFilePermissions houses the default mode to use when no file permissions are provided
	DefaultFilePermissions os.FileMode = 0o644
)

Variables

This section is empty.

Functions

func NewReader 

func NewReader() *reader

New creates a new writer

func NewWriter 

func NewWriter() *writer

New creates a new writer

Types

type ManagedFile 

type ManagedFile interface {
	Path() string
	Exists() (bool, error)
	IsUpToDate() (bool, error)
	Write() error
}

type MockManagedFile 

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

MockManagedFile is a mock of ManagedFile interface.

func NewMockManagedFile 

func NewMockManagedFile(ctrl *gomock.Controller) *MockManagedFile

NewMockManagedFile creates a new mock instance.

func (*MockManagedFile) EXPECT 

func (m *MockManagedFile) EXPECT() *MockManagedFileMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockManagedFile) Exists 

func (m *MockManagedFile) Exists() (bool, error)

Exists mocks base method.

func (*MockManagedFile) IsUpToDate 

func (m *MockManagedFile) IsUpToDate() (bool, error)

IsUpToDate mocks base method.

func (*MockManagedFile) Path 

func (m *MockManagedFile) Path() string

Path mocks base method.

func (*MockManagedFile) Write 

func (m *MockManagedFile) Write() error

Write mocks base method.

type MockManagedFileMockRecorder 

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

MockManagedFileMockRecorder is the mock recorder for MockManagedFile.

func (*MockManagedFileMockRecorder) Exists 

func (mr *MockManagedFileMockRecorder) Exists() *gomock.Call

Exists indicates an expected call of Exists.

func (*MockManagedFileMockRecorder) IsUpToDate 

func (mr *MockManagedFileMockRecorder) IsUpToDate() *gomock.Call

IsUpToDate indicates an expected call of IsUpToDate.

func (*MockManagedFileMockRecorder) Path 

func (mr *MockManagedFileMockRecorder) Path() *gomock.Call

Path indicates an expected call of Path.

func (*MockManagedFileMockRecorder) Write 

func (mr *MockManagedFileMockRecorder) Write() *gomock.Call

Write indicates an expected call of Write.

type MockReadWriter 

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

MockReadWriter is a mock of ReadWriter interface.

func NewMockReadWriter 

func NewMockReadWriter(ctrl *gomock.Controller) *MockReadWriter

NewMockReadWriter creates a new mock instance.

func (*MockReadWriter) CopyFile 

func (m *MockReadWriter) CopyFile(src, dst string) error

CopyFile mocks base method.

func (*MockReadWriter) CreateManagedFile 

func (m *MockReadWriter) CreateManagedFile(file types.File) ManagedFile

CreateManagedFile mocks base method.

func (*MockReadWriter) EXPECT 

func (m *MockReadWriter) EXPECT() *MockReadWriterMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockReadWriter) FileExists 

func (m *MockReadWriter) FileExists(filePath string) (bool, error)

FileExists mocks base method.

func (*MockReadWriter) PathFor 

func (m *MockReadWriter) PathFor(filePath string) string

PathFor mocks base method.

func (*MockReadWriter) ReadFile 

func (m *MockReadWriter) ReadFile(filePath string) ([]byte, error)

ReadFile mocks base method.

func (*MockReadWriter) RemoveFile 

func (m *MockReadWriter) RemoveFile(file string) error

RemoveFile mocks base method.

func (*MockReadWriter) SetRootdir 

func (m *MockReadWriter) SetRootdir(path string)

SetRootdir mocks base method.

func (*MockReadWriter) WriteFile 

func (m *MockReadWriter) WriteFile(name string, data []byte, perm fs.FileMode) error

WriteFile mocks base method.

func (*MockReadWriter) WriteFileBytes 

func (m *MockReadWriter) WriteFileBytes(name string, data []byte, perm os.FileMode) error

WriteFileBytes mocks base method.

type MockReadWriterMockRecorder 

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

MockReadWriterMockRecorder is the mock recorder for MockReadWriter.

func (*MockReadWriterMockRecorder) CopyFile 

func (mr *MockReadWriterMockRecorder) CopyFile(src, dst any) *gomock.Call

CopyFile indicates an expected call of CopyFile.

func (*MockReadWriterMockRecorder) CreateManagedFile 

func (mr *MockReadWriterMockRecorder) CreateManagedFile(file any) *gomock.Call

CreateManagedFile indicates an expected call of CreateManagedFile.

func (*MockReadWriterMockRecorder) FileExists 

func (mr *MockReadWriterMockRecorder) FileExists(filePath any) *gomock.Call

FileExists indicates an expected call of FileExists.

func (*MockReadWriterMockRecorder) PathFor 

func (mr *MockReadWriterMockRecorder) PathFor(filePath any) *gomock.Call

PathFor indicates an expected call of PathFor.

func (*MockReadWriterMockRecorder) ReadFile 

func (mr *MockReadWriterMockRecorder) ReadFile(filePath any) *gomock.Call

ReadFile indicates an expected call of ReadFile.

func (*MockReadWriterMockRecorder) RemoveFile 

func (mr *MockReadWriterMockRecorder) RemoveFile(file any) *gomock.Call

RemoveFile indicates an expected call of RemoveFile.

func (*MockReadWriterMockRecorder) SetRootdir 

func (mr *MockReadWriterMockRecorder) SetRootdir(path any) *gomock.Call

SetRootdir indicates an expected call of SetRootdir.

func (*MockReadWriterMockRecorder) WriteFile 

func (mr *MockReadWriterMockRecorder) WriteFile(name, data, perm any) *gomock.Call

WriteFile indicates an expected call of WriteFile.

func (*MockReadWriterMockRecorder) WriteFileBytes 

func (mr *MockReadWriterMockRecorder) WriteFileBytes(name, data, perm any) *gomock.Call

WriteFileBytes indicates an expected call of WriteFileBytes.

type MockReader 

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

MockReader is a mock of Reader interface.

func NewMockReader 

func NewMockReader(ctrl *gomock.Controller) *MockReader

NewMockReader creates a new mock instance.

func (*MockReader) EXPECT 

func (m *MockReader) EXPECT() *MockReaderMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockReader) FileExists 

func (m *MockReader) FileExists(filePath string) (bool, error)

FileExists mocks base method.

func (*MockReader) PathFor 

func (m *MockReader) PathFor(filePath string) string

PathFor mocks base method.

func (*MockReader) ReadFile 

func (m *MockReader) ReadFile(filePath string) ([]byte, error)

ReadFile mocks base method.

func (*MockReader) SetRootdir 

func (m *MockReader) SetRootdir(path string)

SetRootdir mocks base method.

type MockReaderMockRecorder 

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

MockReaderMockRecorder is the mock recorder for MockReader.

func (*MockReaderMockRecorder) FileExists 

func (mr *MockReaderMockRecorder) FileExists(filePath any) *gomock.Call

FileExists indicates an expected call of FileExists.

func (*MockReaderMockRecorder) PathFor 

func (mr *MockReaderMockRecorder) PathFor(filePath any) *gomock.Call

PathFor indicates an expected call of PathFor.

func (*MockReaderMockRecorder) ReadFile 

func (mr *MockReaderMockRecorder) ReadFile(filePath any) *gomock.Call

ReadFile indicates an expected call of ReadFile.

func (*MockReaderMockRecorder) SetRootdir 

func (mr *MockReaderMockRecorder) SetRootdir(path any) *gomock.Call

SetRootdir indicates an expected call of SetRootdir.

type MockWriter 

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

MockWriter is a mock of Writer interface.

func NewMockWriter 

func NewMockWriter(ctrl *gomock.Controller) *MockWriter

NewMockWriter creates a new mock instance.

func (*MockWriter) CopyFile 

func (m *MockWriter) CopyFile(src, dst string) error

CopyFile mocks base method.

func (*MockWriter) CreateManagedFile 

func (m *MockWriter) CreateManagedFile(file types.File) ManagedFile

CreateManagedFile mocks base method.

func (*MockWriter) EXPECT 

func (m *MockWriter) EXPECT() *MockWriterMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockWriter) RemoveFile 

func (m *MockWriter) RemoveFile(file string) error

RemoveFile mocks base method.

func (*MockWriter) SetRootdir 

func (m *MockWriter) SetRootdir(path string)

SetRootdir mocks base method.

func (*MockWriter) WriteFile 

func (m *MockWriter) WriteFile(name string, data []byte, perm fs.FileMode) error

WriteFile mocks base method.

func (*MockWriter) WriteFileBytes 

func (m *MockWriter) WriteFileBytes(name string, data []byte, perm os.FileMode) error

WriteFileBytes mocks base method.

type MockWriterMockRecorder 

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

MockWriterMockRecorder is the mock recorder for MockWriter.

func (*MockWriterMockRecorder) CopyFile 

func (mr *MockWriterMockRecorder) CopyFile(src, dst any) *gomock.Call

CopyFile indicates an expected call of CopyFile.

func (*MockWriterMockRecorder) CreateManagedFile 

func (mr *MockWriterMockRecorder) CreateManagedFile(file any) *gomock.Call

CreateManagedFile indicates an expected call of CreateManagedFile.

func (*MockWriterMockRecorder) RemoveFile 

func (mr *MockWriterMockRecorder) RemoveFile(file any) *gomock.Call

RemoveFile indicates an expected call of RemoveFile.

func (*MockWriterMockRecorder) SetRootdir 

func (mr *MockWriterMockRecorder) SetRootdir(path any) *gomock.Call

SetRootdir indicates an expected call of SetRootdir.

func (*MockWriterMockRecorder) WriteFile 

func (mr *MockWriterMockRecorder) WriteFile(name, data, perm any) *gomock.Call

WriteFile indicates an expected call of WriteFile.

func (*MockWriterMockRecorder) WriteFileBytes 

func (mr *MockWriterMockRecorder) WriteFileBytes(name, data, perm any) *gomock.Call

WriteFileBytes indicates an expected call of WriteFileBytes.

type Option 

type Option func(*readWriter)

func WithTestRootDir 

func WithTestRootDir(testRootDir string) Option

WithTestRootDir sets the root directory for the reader and writer, useful for testing.

type ReadWriter 

type ReadWriter interface {
	Reader
	Writer
}

func NewReadWriter 

func NewReadWriter(opts ...Option) ReadWriter

type Reader 

type Reader interface {
	SetRootdir(path string)
	PathFor(filePath string) string
	ReadFile(filePath string) ([]byte, error)
	FileExists(filePath string) (bool, error)
}

type Writer 

type Writer interface {
	SetRootdir(path string)
	WriteFileBytes(name string, data []byte, perm os.FileMode) error
	WriteFile(name string, data []byte, perm fs.FileMode) error
	RemoveFile(file string) error
	CopyFile(src, dst string) error
	CreateManagedFile(file ign3types.File) ManagedFile
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.