FileManager

Documentation

Index

• func GetAllFileNamesInDirectory(directoryPath string) (map[string]string, error)
• func GetFilesEndingIn(directoryPath string, extensions ...string) ([]string, error)
• func MediaDownloader(dest, url string) (string, error)
• func SplitPath(filePath string) []string
• type ErrFileNotOpen
  • func NewErrFileNotOpen() *ErrFileNotOpen
  • func (e *ErrFileNotOpen) Error() string
• type FileManager
• type FileReader
  • func NewFileReader(loc string) *FileReader
  • func (fr *FileReader) Exists() (bool, error)
  • func (fr *FileReader) GetLocation() string
  • func (fr *FileReader) Lines() ([]string, error)
  • func (fr *FileReader) Read() (string, error)
• type FileWriter
  • func NewFileWriter(loc string) *FileWriter
  • func (fw *FileWriter) AppendLine(content string) error
  • func (fw *FileWriter) Clear() error
  • func (fw *FileWriter) Close() error
  • func (fw *FileWriter) Create(perm fs.FileMode) error
  • func (fw *FileWriter) Exists() (bool, error)
  • func (fw *FileWriter) GetLocation() string
  • func (fw *FileWriter) Open() error
• type JSONEncoder
• type JSONManager
  • func NewJSONManager[T JSONEncoder](loc string) *JSONManager[T]
  • func (m *JSONManager[T]) ChangePath(path string)
  • func (m *JSONManager[T]) CreateEmpty() error
  • func (m *JSONManager[T]) Delete() error
  • func (m *JSONManager[T]) Exists() (bool, error)
  • func (m *JSONManager[T]) GetLocation() string
  • func (m *JSONManager[T]) Load() error
  • func (m *JSONManager[T]) Save() error

Functions

func GetAllFileNamesInDirectory

func GetAllFileNamesInDirectory(directoryPath string) (map[string]string, error)

GetAllFileNamesInDirectory is a function that retrieves all file names in a given directory and their extensions.

Parameters:

• directoryPath: A string representing the path to the directory.

Returns:

• map[string]string: A map where the keys are the file paths and the values are the file extensions.
• error: An error if it fails to read the directory or any of its files.

func GetFilesEndingIn

func GetFilesEndingIn(directoryPath string, extensions ...string) ([]string, error)

GetFilesEndingIn is a function that retrieves all files in a given directory that have a specified extension. This function does not search subdirectories.

Parameters:

• directoryPath: A string representing the path to the directory.
• extensions: A variadic parameter of strings representing the file extensions to match.

Returns:

• []string: A slice of strings representing the paths to the matching files.
• error: An error if it fails to read the directory.

func MediaDownloader

func MediaDownloader(dest, url string) (string, error)

MediaDownloader downloads a file from the given URL and saves it to the specified destination.

The name of the file is derived from the URL and it does not download the file if the name already exists in the destination.

Parameters:

• dest: A string representing the path to the directory where the file will be saved.
• url: A string representing the URL of the file to download.

Returns:

• string: The path to the downloaded file.
• error: An error if the download fails.

Example:

file_path, err := MediaDownloader("/path/to/destination", "http://example.com/file.mp3")
if err != nil {
    log.Fatal(err)
}
fmt.Println(file_path) // Output: /path/to/destination/file.mp3

func SplitPath

func SplitPath(filePath string) []string

SplitPath splits a file path into its components, where each component is a part of the file path.

Parameters:

• filePath: A string representing the path to the file.

Returns:

• []string: A slice of strings representing the parts of the file path.

Types

type ErrFileNotOpen

type ErrFileNotOpen struct{}

ErrFileNotOpen is an error type for when a file was not opened.

func NewErrFileNotOpen

func NewErrFileNotOpen() *ErrFileNotOpen

NewErrFileNotOpen creates a new ErrFileNotOpen error.

Returns:

• *ErrFileNotOpen: A pointer to the newly created error.

func (*ErrFileNotOpen) Error

func (e *ErrFileNotOpen) Error() string

Error returns the error message: "file was not opened".

type FileManager

type FileManager interface {
	// GetLocation returns the location of the file.
	//
	// Returns:
	//   - string: The location of the file.
	GetLocation() string

	// Exists checks if the file exists at the location.
	//
	// Returns:
	//   - bool: A boolean indicating whether the file exists.
	//   - error: An error if one occurred while checking the file.
	Exists() (bool, error)
}

FileManager represents a file manager that can be used to read and write files.

type FileReader

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

FileReader represents a file reader that can be used to read files.

func NewFileReader

func NewFileReader(loc string) *FileReader

NewFileReader creates a new FileReader with the given location.

Parameters:

• loc: A string representing the location of the file.

Returns:

• *FileReader: A pointer to the newly created FileReader.

func (*FileReader) Exists

func (fr *FileReader) Exists() (bool, error)

Exists checks if the file exists at the location.

Returns:

• bool: A boolean indicating whether the file exists.
• error: An error if one occurred while checking the file.

func (*FileReader) GetLocation

func (fr *FileReader) GetLocation() string

GetLocation returns the location of the file.

Returns:

• string: The location of the file.

func (*FileReader) Lines

func (fr *FileReader) Lines() ([]string, error)

Lines reads the file line by line and returns a slice of strings, where each string represents a line from the file.

Returns:

• []string: A slice of strings where each string is a line from the file.
• error: An error if one occurred while opening or scanning the file.

Behaviors:

• The function reads the file line by line. Each line does not include the newline character.
• If an error occurs, the function returns the error and the lines read up to that point.

func (*FileReader) Read

func (fr *FileReader) Read() (string, error)

ReadFile reads the content of a file from the provided path and returns the content as a string.

Parameters:

• filePath: A string representing the path to the file to be read.

Returns:

• string: A string representing the content of the file.
• error: An error of type *os.PathError if the file could not be opened or read.

Behaviors:

• The function reads the entire file into memory.
• If an error occurs, the function returns the error and an empty string.

type FileWriter

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

FileWriter represents a file writer that can be used to write to files.

func NewFileWriter

func NewFileWriter(loc string) *FileWriter

NewFileWriter creates a new FileWriter with the given location.

Parameters:

• loc: A string representing the location of the file.

Returns:

• *FileWriter: A pointer to the newly created FileWriter.

func (*FileWriter) AppendLine

func (fw *FileWriter) AppendLine(content string) error

AppendLine appends a line of content to the file.

Parameters:

• content: A string representing the content to append to the file.

Returns:

• error: An error if one occurred while writing to the file.

Errors:

• *ErrFileNotOpen: If the file is not open.
• error: If any other case.

func (*FileWriter) Clear

func (fw *FileWriter) Clear() error

Clear clears the contents of the file.

Returns:

• error: An error if one occurred while truncating the file.

Errors:

• *ErrFileNotOpen: If the file is not open.
• *os.PathError: If any other case.

func (*FileWriter) Close

func (fw *FileWriter) Close() error

Close closes the file that is being written to.

Returns:

• error: An error if one occurred while closing the file.

func (*FileWriter) Create

func (fw *FileWriter) Create(perm fs.FileMode) error

Create creates a new file at the location; including any necessary directories.

Parameters:

• perm: An fs.FileMode representing the permissions to set on the file.

Returns:

• error: An error if one occurred while creating the file.

Behaviors:

• If the file already exists, the function does nothing.
• Once the file is opened, it is kept open until the FileWriter is closed.

func (*FileWriter) Exists

func (fw *FileWriter) Exists() (bool, error)

Exists checks if the file exists at the location.

Parameters:

• loc: A string representing the location of the file.

Returns:

• bool: A boolean indicating whether the file exists.
• error: An error if one occurred while checking the file.

func (*FileWriter) GetLocation

func (fw *FileWriter) GetLocation() string

GetLocation returns the location of the file.

Returns:

• string: The location of the file.

func (*FileWriter) Open

func (fw *FileWriter) Open() error

Open opens the file for writing.

Returns:

• *os.File: A pointer to the opened file.
• error: An error if one occurred while opening the file.

Behaviors:

• The file is opened in append mode and write-only.
• If the file is already open, the function does nothing.
• If the file does not exist, the function creates the file.

type JSONEncoder

type JSONEncoder interface {
	json.Marshaler
	json.Unmarshaler

	// Empty returns the default values of the data.
	//
	// Returns:
	//   - JSONEncoder: The default values of the data.
	Empty() JSONEncoder
}

JSONEncoder is an interface for encoding and decoding JSON data.

type JSONManager

type JSONManager[T JSONEncoder] struct {
	// Data is the data to save and load.
	Data T
	// contains filtered or unexported fields
}

JSONManager is a manager for saving and loading data to and from a JSON file.

func NewJSONManager

func NewJSONManager[T JSONEncoder](loc string) *JSONManager[T]

NewJSONManager creates a new JSONManager.

Parameters:

• loc: The path to the JSON file.

Returns:

• JSONManager[T]: The new JSONManager.

func (*JSONManager[T]) ChangePath

func (m *JSONManager[T]) ChangePath(path string)

ChangePath changes the path of the JSON file.

Parameters:

• path: The new path to the JSON file.

func (*JSONManager[T]) CreateEmpty

func (m *JSONManager[T]) CreateEmpty() error

CreateEmpty creates an empty JSON file with the default values of the data. If the file already exists, it will overwrite the file.

Returns:

• error: An error if there was an issue creating the empty file.

func (*JSONManager[T]) Delete

func (m *JSONManager[T]) Delete() error

Delete deletes the JSON file. No operation is performed if the file does not exist.

Returns:

• error: An error if there was an issue deleting the file.

func (*JSONManager[T]) Exists

func (m *JSONManager[T]) Exists() (bool, error)

Exists checks if the JSON file exists.

Returns:

• bool: True if the file exists, false otherwise.
• error: An error if there was an issue checking if the file exists.

func (*JSONManager[T]) GetLocation

func (m *JSONManager[T]) GetLocation() string

GetLocation returns the path to the JSON file.

Returns:

• string: The path to the JSON file.

func (*JSONManager[T]) Load

func (m *JSONManager[T]) Load() error

Load loads the data from the JSON file.

Returns:

• error: An error if there was an issue loading the data.

func (*JSONManager[T]) Save

func (m *JSONManager[T]) Save() error

Save saves the data to the JSON file. It will overwrite the file if it already exists.

Returns:

• error: An error if there was an issue saving the data.