String
Functions for string operations and manipulations.
Table of Contents
string::trim()
Strip whitespace from the beginning and end of a string.
Arguments
- $1 (string): The string to be trimmed.
Exit codes
- 0: If successful.
- 2: Function missing arguments.
Output on stdout
Example
echo "$(string::trim " Hello World! ")"
#Output
Hello World!
string::split()
Split a string to array by a delimiter.
Arguments
- $1 (string): The input string.
- $2 (string): The delimiter string.
Exit codes
- 0: If successful.
- 2: Function missing arguments.
Output on stdout
- Returns an array of strings created by splitting the string parameter by the delimiter.
Example
array=( $(string::split "a,b,c" ",") )
printf "%s" "$(string::split "Hello!World" "!")"
#Output
Hello
World
string::lstrip()
Strip characters from the beginning of a string.
Arguments
- $1 (string): The input string.
- $2 (string): The characters you want to strip.
Exit codes
- 0: If successful.
- 2: Function missing arguments.
Output on stdout
- Returns the modified string.
Example
echo "$(string::lstrip "Hello World!" "He")"
#Output
llo World!
string::rstrip()
Strip characters from the end of a string.
Arguments
- $1 (string): The input string.
- $2 (string): The characters you want to strip.
Exit codes
- 0: If successful.
- 2: Function missing arguments.
Output on stdout
- Returns the modified string.
Example
echo "$(string::rstrip "Hello World!" "d!")"
#Output
Hello Worl
string::to_lower()
Make a string lowercase.
Arguments
- $1 (string): The input string.
Exit codes
- 0: If successful.
- 2: Function missing arguments.
Output on stdout
- Returns the lowercased string.
Example
echo "$(string::to_lower "HellO")"
#Output
hello
string::to_upper()
Make a string all uppercase.
Arguments
- $1 (string): The input string.
Exit codes
- 0: If successful.
- 2: Function missing arguments.
Output on stdout
- Returns the uppercased string.
Example
echo "$(string::to_upper "HellO")"
#Output
HELLO
string::contains()
Check whether the search string exists within the input string.
Arguments
- $1 (string): The input string.
- $2 (string): The search key.
Exit codes
- 0: If match found.
- 1: If no match found.
- 2: Function missing arguments.
Example
string::contains "Hello World!" "lo"
string::starts_with()
Check whether the input string starts with key string.
Arguments
- $1 (string): The input string.
- $2 (string): The search key.
Exit codes
- 0: If match found.
- 1: If no match found.
- 2: Function missing arguments.
Example
string::starts_with "Hello World!" "He"
string::ends_with()
Check whether the input string ends with key string.
Arguments
- $1 (string): The input string.
- $2 (string): The search key.
Exit codes
- 0: If match found.
- 1: If no match found.
- 2: Function missing arguments.
Example
string::ends_with "Hello World!" "d!"
string::regex()
Check whether the input string matches the given regex.
Arguments
- $1 (string): The input string.
- $2 (string): The search key.
Exit codes
- 0: If match found.
- 1: If no match found.
- 2: Function missing arguments.
Example
string::regex "HELLO" "^[A-Z]*$"