files

Documentation

Index

• type FileManager
  • func GetFileManager() FileManager
• type LocalFileManager
  • func (l LocalFileManager) CheckFileExists(key string) (bool, error)
  • func (l LocalFileManager) CopyDirectory(sourcePrefix, destinationPrefix string) error
  • func (l LocalFileManager) DeleteFile(key string) error
  • func (l LocalFileManager) DeleteFileIfExists(key string) error
  • func (l LocalFileManager) DeleteRecursive(key string) error
  • func (l LocalFileManager) ListDirectories(prefix string) ([]string, error)
  • func (l LocalFileManager) ListFilesRecursive(prefix string) ([]string, error)
  • func (l LocalFileManager) Mkdirp(prefix string) error
  • func (l LocalFileManager) ReadFile(key string) ([]byte, error)
  • func (l LocalFileManager) ReadJSON(key string, v interface{}) error
  • func (l LocalFileManager) WriteFile(key string, content []byte) error
  • func (l LocalFileManager) WriteJSON(key string, v interface{}) error
• type S3Manager
  • func (m S3Manager) CheckFileExists(key string) (bool, error)
  • func (m S3Manager) CopyDirectory(sourcePrefix, destinationPrefix string) error
  • func (m S3Manager) DeleteFile(key string) error
  • func (m S3Manager) DeleteFileIfExists(key string) error
  • func (m S3Manager) DeleteRecursive(key string) error
  • func (m S3Manager) ListDirectories(prefix string) ([]string, error)
  • func (m S3Manager) ListFilesRecursive(prefix string) ([]string, error)
  • func (m S3Manager) Mkdirp(path string) error
  • func (m S3Manager) ReadFile(key string) ([]byte, error)
  • func (m S3Manager) ReadJSON(key string, v interface{}) error
  • func (m S3Manager) WriteFile(key string, content []byte) error
  • func (m S3Manager) WriteJSON(key string, v interface{}) error

Types

type FileManager

type FileManager interface {
	ListFilesRecursive(prefix string) ([]string, error)
	ListDirectories(prefix string) ([]string, error)
	Mkdirp(key string) error
	ReadFile(key string) ([]byte, error)
	ReadJSON(key string, v interface{}) error
	WriteFile(key string, content []byte) error
	WriteJSON(key string, v interface{}) error
	CheckFileExists(key string) (bool, error)
	DeleteFile(key string) error
	DeleteRecursive(key string) error
	DeleteFileIfExists(key string) error
	CopyDirectory(sourcePrefix, destinationPrefix string) error
}

FileManager defines the operations for a file management system.

func GetFileManager

func GetFileManager() FileManager

GetFileManager returns a singleton FileManager instance based on environment configuration.

type LocalFileManager

type LocalFileManager struct {
	BasePath string // Base directory for operations, analogous to BucketName in S3Manager.
}

LocalFileManager struct to handle local filesystem operations.

func (LocalFileManager) CheckFileExists

func (l LocalFileManager) CheckFileExists(key string) (bool, error)

CheckFileExists checks if a file exists at the specified path.

func (LocalFileManager) CopyDirectory

func (l LocalFileManager) CopyDirectory(sourcePrefix, destinationPrefix string) error

CopyDirectory copies the contents of one directory to another.

func (LocalFileManager) DeleteFile

func (l LocalFileManager) DeleteFile(key string) error

DeleteFile deletes a file.

func (LocalFileManager) DeleteFileIfExists

func (l LocalFileManager) DeleteFileIfExists(key string) error

DeleteFileIfExists deletes a file if it exists.

func (LocalFileManager) DeleteRecursive

func (l LocalFileManager) DeleteRecursive(key string) error

DeleteRecursive deletes a directory and all its contents.

func (LocalFileManager) ListDirectories

func (l LocalFileManager) ListDirectories(prefix string) ([]string, error)

ListDirectories lists all directories under a given directory prefix.

func (LocalFileManager) ListFilesRecursive

func (l LocalFileManager) ListFilesRecursive(prefix string) ([]string, error)

ListFilesRecursive lists all files recursively under a given directory prefix.

func (LocalFileManager) Mkdirp

func (l LocalFileManager) Mkdirp(prefix string) error

Mkdirp creates a directory and all necessary parents.

func (LocalFileManager) ReadFile

func (l LocalFileManager) ReadFile(key string) ([]byte, error)

ReadFile reads the contents of a file.

func (LocalFileManager) ReadJSON

func (l LocalFileManager) ReadJSON(key string, v interface{}) error

ReadJSON reads a JSON file into a variable.

func (LocalFileManager) WriteFile

func (l LocalFileManager) WriteFile(key string, content []byte) error

WriteFile writes content to a file.

func (LocalFileManager) WriteJSON

func (l LocalFileManager) WriteJSON(key string, v interface{}) error

WriteJSON writes a variable as JSON to a file.

type S3Manager

type S3Manager struct {
	Client     *s3.Client
	BucketName string
}

S3Manager struct holds the S3 client and bucket name.

func (S3Manager) CheckFileExists

func (m S3Manager) CheckFileExists(key string) (bool, error)

CheckFileExists checks if a specific file exists in S3.

func (S3Manager) CopyDirectory

func (m S3Manager) CopyDirectory(sourcePrefix, destinationPrefix string) error

CopyDirectory copies all files from one directory to another within S3.

func (S3Manager) DeleteFile

func (m S3Manager) DeleteFile(key string) error

DeleteFile deletes a file from the S3 bucket.

func (S3Manager) DeleteFileIfExists

func (m S3Manager) DeleteFileIfExists(key string) error

DeleteFileIfExists checks if a file exists in S3 and deletes it if present.

func (S3Manager) DeleteRecursive

func (m S3Manager) DeleteRecursive(key string) error

DeleteRecursive deletes all files under a given prefix.

func (S3Manager) ListDirectories

func (m S3Manager) ListDirectories(prefix string) ([]string, error)

ListDirectories lists the directories under a given prefix.

func (S3Manager) ListFilesRecursive

func (m S3Manager) ListFilesRecursive(prefix string) ([]string, error)

ListFilesRecursive lists all files under a given prefix recursively.

func (S3Manager) Mkdirp

func (m S3Manager) Mkdirp(path string) error

Mkdirp simulates creating a directory in S3.

func (S3Manager) ReadFile

func (m S3Manager) ReadFile(key string) ([]byte, error)

ReadFile reads the content of a file from the S3 bucket.

func (S3Manager) ReadJSON

func (m S3Manager) ReadJSON(key string, v interface{}) error

ReadJSON reads a JSON file from S3 into a variable.

func (S3Manager) WriteFile

func (m S3Manager) WriteFile(key string, content []byte) error

WriteFile writes content to a file in the S3 bucket.

func (S3Manager) WriteJSON

func (m S3Manager) WriteJSON(key string, v interface{}) error

WriteJSON writes a variable as JSON to a file in S3.