package
0.0.0-20240715100550-591e6cb312a2
Repository: https://github.com/braswelljr/rmx.git
Documentation: pkg.go.dev

# Functions

ByteCountSI - converts bytes to {bytes, KB, MB, GB} @param {int64} b - the number of bytes @return {string} - the converted bytes.
Dedent - trims spaces on the left side of a line @param {string} s - string to dedent @return {string}.
Exists - checks if a directory exists @param {string} path - the path to the directory @return {bool} - true if the directory exists @return {error} - error.
FileSize - gets the file size @param {string} filename - the filename @return {int64} - the file size.
FileSizeToString - gets the file size and converts it to {bytes, KB, MB, GB} @param {string} filename - the filename @return {string} - the file size.
GenerateRandomKey - generates a random key for the hill cipher @param n - the size of the key @return key - the key.
GetFile - gets the file @param {string} path - the path to the file @return {File} - the file.
GetFileExtension - gets the file extension @param {string} filename - the filename @return {string} - the file extension.
GetFiles - gets the files in a directory @param {string} path - the path to the directory @return {[]File} - the files.
Indent - indents the string @param s - the string to indent @param indent - the number of spaces to indent @return string - the indented string.
IsDirectory returns true if the path is a directory.
IsEmpty returns true if the directory is empty @param path - the path to the directory @return bool - true if the directory is empty.
IsHidden returns true if the file/directory is hidden @param path - the path to the file/directory @param forceHidden - true if the file/directory is forced to be hidden @return bool - true if the file/directory is hidden.
LPad - adds padding to the left of a command @param {string} s - string to be worked on @param {int} padding - number of padding @return string.
MergeStructs - merge multiple structs into one struct @param {interface{}} structs - structs to be merged @return interface{}.
Prompt - prompt the user for confirmation.
RPad - adds padding to the right of a command @param {string} s - string to be worked on @param {int} padding - number of padding @return string.
WalkDirectory - repeatedly steps through a directory and returns the @param {string} root - the path to the directory @return {*Directory} - the directory info @return {error} - error.

# Structs

Directory - a directory structure.
File - a file structure.
InteractivePrompt - the prompt to display to the user.