strmech

func (*DataFieldProfileDto) ConvertToErrorState ¶

func (dfProfile *DataFieldProfileDto) ConvertToErrorState()

ConvertToErrorState - Prepares the current DataFieldProfileDto instance for return as part of an error or null state condition. All references to the data field are zeroed.

func (DataFieldProfileDto) New ¶

func (dfProfile DataFieldProfileDto) New() DataFieldProfileDto

New - Creates and returns a new instance of DataFieldProfileDto containing properly initialized internal data fields.

func (DataFieldTrailingDelimiterType) Comment ¶

func (dfTrailDelimiter DataFieldTrailingDelimiterType) Comment() DataFieldTrailingDelimiterType

Comment - The Data Field is terminated by a trailing 'comment' separator.

func (DataFieldTrailingDelimiterType) EndOfField ¶

func (dfTrailDelimiter DataFieldTrailingDelimiterType) EndOfField() DataFieldTrailingDelimiterType

EndOfField - The Data Field is terminated by a trailing end of field separator.

func (DataFieldTrailingDelimiterType) EndOfLine ¶

func (dfTrailDelimiter DataFieldTrailingDelimiterType) EndOfLine() DataFieldTrailingDelimiterType

EndOfLine - The Data Field is terminated by a designated end-of-line separator. Often this is a designated new line character such as '\n'.

func (DataFieldTrailingDelimiterType) EndOfString ¶

func (dfTrailDelimiter DataFieldTrailingDelimiterType) EndOfString() DataFieldTrailingDelimiterType

EndOfString - No specific character terminated the data field. The next character after the data field represents the end of the host string.

func (DataFieldTrailingDelimiterType) StatusIsValid ¶

func (dfTrailDelimiter DataFieldTrailingDelimiterType) StatusIsValid() error

StatusIsValid - If the value of the current DataFieldTrailingDelimiterType instance is 'invalid', this method will return an error.

If the DataFieldTrailingDelimiterType is instance is 'valid', this method will return a value of 'nil'.

This is a standard utility method and is not part of the valid enumerations for this type.

func (DataFieldTrailingDelimiterType) String ¶

func (dfTrailDelimiter DataFieldTrailingDelimiterType) String() string

String - Returns a string with the name of the enumeration associated with this instance of 'DataFieldTrailingDelimiterType'.

This is a standard utility method and is not part of the valid enumerations for this type.

------------------------------------------------------------------------

Return Value:

string - The string label or description for the current enumeration
         value. If, the DataFieldTrailingDelimiterType value is invalid,
         this method will return an empty string.

------------------------------------------------------------------------

Usage

t:= DataFieldTrailingDelimiterType(0).EndOfLine()
str := t.String()
    str is now equal to "EndOfLine"

func (DataFieldTrailingDelimiterType) Unknown ¶

func (dfTrailDelimiter DataFieldTrailingDelimiterType) Unknown() DataFieldTrailingDelimiterType

Unknown - Data Field Trailing Delimiter Type is unknown or undetermined.

func (DataFieldTrailingDelimiterType) XIsValid ¶

func (dfTrailDelimiter DataFieldTrailingDelimiterType) XIsValid() bool

XIsValid - Returns a boolean value signaling whether the current TextJustify value is valid.

This is a standard utility method and is not part of the valid enumerations for this type.

------------------------------------------------------------------------

Usage

trailDelimType := DataFieldTrailingDelimiterType(0).EndOfField()

isValid := trailDelimType.XIsValid()

func (DataFieldTrailingDelimiterType) XParseString ¶

func (dfTrailDelimiter DataFieldTrailingDelimiterType) XParseString(
	valueString string,
	caseSensitive bool) (DataFieldTrailingDelimiterType, error)

XParseString - Receives a string and attempts to match it with the string value of the supported enumeration. If successful, a new instance of TimeZoneClass is returned set to the value of the associated enumeration.

This is a standard utility method and is not part of the valid enumerations for this type.

------------------------------------------------------------------------

Input Parameters:

valueString   string - A string which will be matched against the
                       enumeration string values. If 'valueString'
                       is equal to one of the enumeration names, this
                       method will proceed to successful completion

caseSensitive   bool - If 'true' the search for enumeration names
                       will be case sensitive and will require an
                       exact match. Therefore, 'valid' will NOT
                       match the enumeration name, 'Valid'.

                       If 'false' a case insensitive search is
                       conducted for the enumeration name. In
                       this case, 'valid' will match the
                       enumeration name 'Valid'.

------------------------------------------------------------------------

Return Values:

DataFieldTrailingDelimiterType  - Upon successful completion, this method will return a new
                                  instance of DataFieldTrailingDelimiterType set to the value
                                  of the enumeration matched by the string search performed on
                                  input parameter,'valueString'.

error                           - If this method completes successfully, the returned error
                                  Type is set equal to 'nil'. If an error condition is encountered,
                                  this method will return an error Type which encapsulates an
                                  appropriate error message.

------------------------------------------------------------------------

Usage:

t, err := DataFieldTrailingDelimiterType(0).ParseString("EndOfLine", true)
                          OR
t, err := DataFieldTrailingDelimiterType(0).ParseString("EndOfLine()", true)
                          OR
t, err := DataFieldTrailingDelimiterType(0).ParseString("endofline", false)

For all of the cases shown above,
t is now equal to DataFieldTrailingDelimiterType(0).EndOfLine()

func (DataFieldTrailingDelimiterType) XValueInt ¶

func (dfTrailDelimiter DataFieldTrailingDelimiterType) XValueInt() int

XValueInt Value - Returns the value of the DataFieldTrailingDelimiterType instance as type int.

func (NumStrProfileDto) New ¶

func (exNumDto NumStrProfileDto) New() NumStrProfileDto

New - Creates and returns a new instance of NumStrProfileDto which is properly initialized.

func (SortStrLengthHighestToLowest) Len ¶

func (sortStrLenHigh SortStrLengthHighestToLowest) Len() int

Len - This is part of the sort.Interface. Reference the 'sort' package:

https://golang.org/pkg/sort/#Interface
https://golang.org/pkg/sort/#Sort

func (SortStrLengthHighestToLowest) Less ¶

func (sortStrLenHigh SortStrLengthHighestToLowest) Less(i, j int) bool

Less - This is part of the sort.Interface. Reference the 'sort' package:

https://golang.org/pkg/sort/#Interface
https://golang.org/pkg/sort/#Sort

func (SortStrLengthHighestToLowest) Swap ¶

func (sortStrLenHigh SortStrLengthHighestToLowest) Swap(i, j int)

Swap - This is part of the sort.Interface. Reference the 'sort' package:

https://golang.org/pkg/sort/#Interface
https://golang.org/pkg/sort/#Sort

func (SortStrLengthLowestToHighest) Len ¶

func (sortStrLenLow SortStrLengthLowestToHighest) Len() int

Len - This is part of the sort.Interface. Reference the 'sort' package:

https://golang.org/pkg/sort/#Interface
https://golang.org/pkg/sort/#Sort

func (SortStrLengthLowestToHighest) Less ¶

func (sortStrLenLow SortStrLengthLowestToHighest) Less(i, j int) bool

Less - This is part of the sort.Interface. Reference the 'sort' package:

https://golang.org/pkg/sort/#Interface
https://golang.org/pkg/sort/#Sort

func (SortStrLengthLowestToHighest) Swap ¶

func (sortStrLenLow SortStrLengthLowestToHighest) Swap(i, j int)

Swap - This is part of the sort.Interface. Reference the 'sort' package:

https://golang.org/pkg/sort/#Interface
https://golang.org/pkg/sort/#Sort

func (*StrMech) BreakTextAtLineLength ¶

func (sMech *StrMech) BreakTextAtLineLength(
	targetStr string,
	lineLength int,
	lineDelimiter rune,
	errorPrefix interface{}) (
	string,
	error)

BreakTextAtLineLength - Breaks string text into lines. Takes a string and inserts a line delimiter character (a.k.a 'rune') at the specified line length ('lineLength').

------------------------------------------------------------------------

Input Parameters

targetStr           string
   - The string which will be parsed into text lines. If
     'targetStr' is an empty string an error will be returned.
      If 'targetStr' consists entirely of white space, this
      method will return a string consisting of a new-line
      character and an error value of 'nil'.

lineLength          int
   - The maximum length of each line.

lineDelimiter       rune
   - The line delimiter character which will be inserted at the
     end of a line break.

     Note: If the caller specifies a line length of 50, the
     line delimiter character may be placed in the 51st
     character position depending upon the word breaks.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

string
   - If this method completes successfully, this string
     parameter will contain the text with line breaks delimited
     by the input parameter 'lineDelimiter'.

error
   - If this method completes successfully, the returned error
     Type is set equal to 'nil'. If errors are encountered during
     processing, the returned error Type will encapsulate an error
     message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

func (*StrMech) ConvertNonPrintableChars ¶

func (sMech *StrMech) ConvertNonPrintableChars(
	nonPrintableChars []rune,
	convertSpace bool) (
	printableChars string)

ConvertNonPrintableChars - Receives a string containing non-printable characters and converts them to 'printable' characters returned in a string.

Examples of non-printable characters are '\n', '\t' or 0x06 (Acknowledge). These example characters would be translated into printable string characters as: "\\n", "\\t" and "[ACK]".

Space characters are typically translated as " ". However, if the input parameter 'convertSpace' is set to 'true' then all spaces are converted to "[SPACE]" in the returned string.

Reference:

https://www.juniper.net/documentation/en_US/idp5.1/topics/reference/general/intrusion-detection-prevention-custom-attack-object-extended-ascii.html

------------------------------------------------------------------------

Input Parameters

nonPrintableChars   []rune
   - An array of runes containing non-printable characters.
     The non-printable characters will be converted to
     printable characters.

convertSpace        bool
   - Space or white space characters (0x20) are by default
     translated as " ". However, if this parameter is set to
     'true', space characters will be converted to "[SPACE]".

------------------------------------------------------------------------

Return Values

printableChars      string
   - This returned string is identical to input parameter
     'nonPrintableChars' with the exception that non-printable
     characters are translated into printable characters.

------------------------------------------------------------------------

Example Usage

testStr := "Hello world!\n"
testRunes := []rune(testStr)

actualStr :=
  StrMech{}.NewPtr().
    ConvertNonPrintableChars(testRunes, true)

----------------------------------------------------
'actualStr' is now equal to:
   "Hello[SPACE]world!\\n"

func (*StrMech) ConvertPrintableChars ¶

func (sMech *StrMech) ConvertPrintableChars(
	printableChars string,
	errorPrefix interface{}) (
	nonPrintableChars []rune,
	err error)

ConvertPrintableChars - Converts printable characters to their non-printable or native equivalent. For example, instances of '\\n' in a string will be converted to '\n'.

Additional examples of converted printable string characters are: "\\n", "\\t" and "[ACK]". These printable characters be converted into their native, non-printable state: '\n', '\t' or 0x06 (Acknowledge).

This method, StrMech.ConvertPrintableChars(), performs the mirror operation to that performed by method StrMech.ConvertNonPrintableChars().

StrMech.ConvertNonPrintableChars() converts non-printable characters into printable characters.

StrMech.ConvertPrintableChars() preforms in just the opposite manner. It converts printable characters back into non-printable characters.

If StrMech.ConvertNonPrintableChars() is called on a string containing non-printable characters, calling StrMech.ConvertPrintableChars() on the resulting string will reverse the operation and return that string to its original content.

Reference:

https://www.juniper.net/documentation/en_US/idp5.1/topics/reference/general/intrusion-detection-prevention-custom-attack-object-extended-ascii.html

------------------------------------------------------------------------

Input Parameters

printableChars      string
   - A string which may contain non-printable characters converted
     to their printable equivalents. These printable characters will
     be converted back to their native, non-printable values.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

nonPrintableChars   []rune
   - An array of runes containing non-printable characters.
     The non-printable characters were be converted from the
     printable characters contained in input parameter
     'printableChars'.

err                 error
   - If this method completes successfully, the returned error
     Type is set equal to 'nil'. If errors are encountered during
     processing, the returned error Type will encapsulate an error
     message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

testStr := "Hello[SPACE]world!\\n"
ePrefix := "theCallingFunction()"

sMech := StrMech{}

actualRuneArray :=
  sMech.
    ConvertPrintableChars(
         testStr,
         ePrefix)

----------------------------------------------------
'actualRuneArray' is now equal to:
   "Hello world!\n"

func (*StrMech) CopyIn ¶

func (sMech *StrMech) CopyIn(strops2 *StrMech)

CopyIn - Copies string information from another StrMech instance passed as an input parameter to the current StrMech instance.

func (*StrMech) CopyOut ¶

func (sMech *StrMech) CopyOut() *StrMech

CopyOut - Creates a 'deep' copy of the current StrMech instance and returns a pointer to a new instance containing that copied information.

func (StrMech) DoesLastCharExist ¶

func (sMech StrMech) DoesLastCharExist(
	testStr string,
	lastChar rune) bool

DoesLastCharExist - returns true if the last character (rune) of input string 'testStr' is equal to input parameter 'lastChar' which is of type 'rune'.

func (*StrMech) ExtractDataField ¶

func (sMech *StrMech) ExtractDataField(
	targetStr string,
	leadingKeyWordDelimiters []string,
	startIdx int,
	leadingFieldSeparators []string,
	trailingFieldSeparators []string,
	commentDelimiters []string,
	endOfLineDelimiters []string,
	errorPrefix interface{}) (
	DataFieldProfileDto,
	error)

ExtractDataField - Extracts a data field string from a larger target string ('targetStr'). The target string is searched for a data field. If the 'leadingKeyWordDelimiter' parameter is populated, the data field MUST contain this leading key word, otherwise an empty data field is returned.

If 'leadingKeyWordDelimiter' is an empty string, the search for the data field will begin at 'targetStr' index, 'startIdx'.

The returned data field must occur in 'targetStr' prior to a comment or End-Of-Line character.

The extracted data field MUST be preceded by one of the characters specified in input parameter, 'leadingFieldSeparators'. In addition, the data field must be immediately followed by one of the characters in input parameter 'trailingFieldSeparators' or a comment or an End-Of-Line character.

------------------------------------------------------------------------

Input Values

targetStr                  string
   - The target string from which the data field will be extracted.

leadingKeyWordDelimiters   []string
   - Data fields are often preceded by field names or field designators.
     The 'leadingKeyWordDelimiters' parameter is a string array
     containing 'Key Word Delimiters'. A Key Word Delimiter may be
     a Key Word string or a character which identifies and immediately
     precedes the data field. If multiple Key Word Delimiters exist
     in 'targetStr' the first instance of a key word in targetStr'
     will be designated as the Key Word Delimiter.

     If this parameter is populated, the search for a data field
     will begin immediately after the first located Key Word
     Delimiter string. If none of Key Words in this string array
     are located in 'targetStr', an empty string will be returned
     for data field. If this parameter is populated, at least one
     of the Key Words MUST exist in 'targetStr' before a data field
     will be extracted and returned.

     If this parameter is an empty string array, the search for a
     data field will begin at the string index designated by
     parameter, 'startIdx'.

startIdx                   int
   - The string index in parameter 'targetStr' from which the search for
     a data field will begin. Note that the starting index will be adjusted
     according to the existence of a Key Word Delimiter as explained
     above.

leadingFieldSeparators     []string
   - An array of characters or groups of characters which delimit the
     leading edge of the data field.

trailingFieldSeparators    []string
   - An array of characters or groups of characters which delimit the
     end of a data field.

commentDelimiters        []string
   - Comments effectively terminate the search for a data field. This
     array stores comment characters or phrases which signal the beginning
     of a comment.

endOfLineDelimiters        []string
   - Those characters or groups of characters which mark the end of a line.
     Generally this includes characters like 'new line' or 'carriage return'.
     End of line characters will terminate the search for a data field.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

DataFieldProfileDto - If successful, this method returns a structure containing
                      characteristics describing the extracted data field.

  type DataFieldProfileDto struct {
     TargetStr                      string //  The string from which the data field is extracted.
     TargetStrLength                int    //  Length of 'TargetStr'
     TargetStrStartIndex            int    //  The index with in 'TargetStr' from which the search for a data field was initiated.
     TargetStrLastGoodIndex         int    //  Last valid index in target string which is less than the target string length and is NOT an 'End Of Field' or 'End Of Line' Delimiter.
     LeadingKeyWordDelimiter        string //  The Leading Key Word Delimiter which is used to identify the beginning of the field search.
     LeadingKeyWordDelimiterIndex   int    //  Index of the found Leading Key Word Delimiter.
     DataFieldStr                   string //  The extracted data field string.
     DataFieldIndex                 int    //  The index in 'TargetStr' where the data field begins.
     DataFieldLength                int    //  The length of the extracted data field string.
     DataFieldTrailingDelimiter     string //  The trailing character which marked the end of the data field. A zero value indicates end of string encountered.
     DataFieldTrailingDelimiterType DataFieldTrailingDelimiterType // A constant or enumeration type used to describe the type of delimiter used to mark the end of a data field.
     NextTargetStrIndex             int    //  The index in 'TargetStr' immediately following the extracted data field.
     CommentDelimiter               string //  If a Comment Delimiter is detected it is stored here.
     CommentDelimiterIndex          int    //  If a Comment Delimiter is detected, the string index in 'TargetStr' showing its location is stored here.
     EndOfLineDelimiter             string //  If an End-Of-Line Delimiter is detected it is captured and stored here.
     EndOfLineDelimiterIndex        int    //  If an End-Of-Line Delimiter is detected, the string index in 'TargetStr' showing its location is stored here.
   }

 error
   - If the method completes successfully and no errors are encountered
     this return value is set to 'nil'. Otherwise, if errors are encountered
     this return value will contain an appropriate error message.

     The most likely source of errors are invalid input parameters.
     Input parameters 'targetStr', 'startIdx', 'leadingFieldSeparators',
     'trailingFieldSeparators' and 'endOfStringDelimiters' are required input
     parameters and must be populated with valid data.

     If an error message is returned, the input parameter
     'errorPrefix' (error prefix) will be inserted or prefixed
     at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

ePrefix := "TestStrOps_ExtractDataField_01()"
endOfLineDelimiters := []string{"\n"}
commentDelimiters := []string{"#"}
leadingFieldDelimiters := []string{
"\t",
"\r",
"\f",
"\v",
" "}

trailingFieldDelimiters := []string{
"\t",
"\r",
"\f",
"\v",
" "}

targetStr := " Zone:\t America/Chicago\t Link:\t US/Central\t\n"
startIdx := 0
leadingKeyWordDelimiters := []string{"Zone:", "Link:"}

datDto,
err :=
  StrMech{}.Ptr().
      ExtractDataField(
         targetStr,
         leadingKeyWordDelimiters,
         startIdx,
         leadingFieldDelimiters,
         trailingFieldDelimiters,
         commentDelimiters,
         endOfLineDelimiters,
         ePrefix)

-----------------------------------------------
datDto.DataFieldStr is now equal to:
        "America/Chicago"

func (*StrMech) ExtractNumericDigits ¶

func (sMech *StrMech) ExtractNumericDigits(
	targetStr string,
	startIndex int,
	keepLeadingChars string,
	keepInteriorChars string,
	keepTrailingChars string,
	errorPrefix interface{}) (
	NumStrProfileDto,
	error)

ExtractNumericDigits - Examines an input parameter 'targetStr' to identify and extract the first instance of a number string. The number string will be comprised of one or more consecutive numeric digits (0-9) and may include leading, trailing or interior non-numeric characters as specified by input parameters.

The search for this number string will be started at the index specified by input parameter 'startIdx'. Beginning at 'startIdx' the 'targetStr' will be searched to identify and extract the first instance of a number string.

A number string is usually defined a string of consecutive numeric digits. However, this method allows the caller to include additional non-numeric characters as identified by input parameters 'keepLeadingChars', 'keepInteriorChars' and 'keepTrailingChars'.

'keepLeadingChars' is a string of characters which will be prefixed to the number string if those characters exist in 'targetStr' and immediately precede the number string.

'keepInteriorChars' is a string of characters which, if they exist within the number string, will be retained and presented in the final extracted number string.

'keepTrailingChars' is a string of characters which will be suffixed to the end of the final extracted number string. To qualify, the designated 'keepTrailingChars' must immediately follow the number string contained in 'targetStr'.

If successfully located within 'targetStr' the first instance of a number string along with characteristics describing that number string are returned in a Type 'NumStrProfileDto'.

------------------------------------------------------------------------

Input Parameters

targetStr           string
   - The target string to be searched for the first instance of
     a number string. A number string is usually defined as a
     string comprised of one or more consecutive numeric digits.
     Additional parameters provided by this method will allow
     the caller to insert specified non-numeric characters at
     the beginning, end or interior of a number string.

startIdx            int
   - The starting index in input parameter 'targetStr'
     from which the search for a number string will be
     initiated. This useful in extracting multiple number
     strings form a single 'targetStr'.

     If 'startIndex' is less than zero or if 'startIndex' exceeds
     the last character index in 'targetStr', an error will be
     returned.

keepLeadingChars    string
   - This string contains non-numeric characters which will be
     retained as a prefix to the final number string extracted
     from the 'targetStr' parameter. To be included, these characters
     must exist in 'targetStr' and must immediately precede the
     first instance of a number string.

     For example, if the target string is "Hello $123789 world" and
     parameter 'keepLeadingChars' includes the USA currency character,
     '$', the returned number string would be '$123789'.  If no currency
     character was included in 'keepLeadingChars', the returned number
     string would be '123789'. It is worth noting that if the target
     string was '$ 123789' and a currency symbol, '$', was included
     in 'keepLeadingChars', the returned number string would still be
     '123789' because 'keepLeadingChars' characters must immediately
     precede the string of numeric digits in 'targetStr'.

     Specifically, if the plus ('+') and minus ('-') sign are NOT
     included in 'keepLeadingChars' those leading number signs will
     never be included in the final number string.

     Leading characters will not be repeated. If for some reason you
     wanted to retain two leading currency symbols ("$$") it would be
     necessary to include two currency characters in 'keepLeadingChars'.

keepInteriorChars   string
   - This string contains non-numeric characters which will be retained
     as valid characters within the final extracted number string. The
     characters must exist withing the first instance of a number string
     located in 'targetStr'. Such interior characters might include
     thousands separators (commas) or decimal points (periods).

     For example, if a comma and a period are included in 'keepInteriorChars'
     and the target string is "Hello word 123,456,789.25 !", the returned
     number string would be "123,456,789.25".  If the comma character was
     NOT included in the 'keepInteriorChars' string, the returned number
     string would be '123', since the number string extraction parser
     would break on the comma, a non-numeric digit.

     'keepInteriorChars' will NOT allow multiple non-numeric characters
     to exist within the interior of the final extracted number string.
     Only single non-numeric characters are allowed within a number string.

keepTrailingChars   string
   - This string contains non-numeric characters which should be retained
     at the end of the final number string. By default, a non-numeric
     character will mark the end of a number string. However, if the caller
     elects to use parameter 'keepTrailingChars' to retain non-numeric
     characters such as a trailing right-parenthesis, then those non-numeric
     characters will be retained in the final extracted number string.

     Trailing characters will not be repeated. If for some reason you
     wanted to retain two closing parentheses symbols ("))") it would be
     necessary to include closing parentheses characters in 'keepTrailingChars'.

     It should be emphasized that 'keepTrailingChars' must immediately
     follow the first instance of a number string in parameter, 'targetStr'.

     Example #1:
       Target String = "Hello world, (1234). Today is new day."
       keepLeadingChars = "("
       keepInteriorChars = ""
       keepTrailingChars= ")"
       Extracted Number String = "(1234)"

     Example #2:
       Target String = "Hello world, USA GDP growth is projected at 1.8%."
       keepLeadingChars = ""
       keepInteriorChars = "."
       keepTrailingChars= "%"
       Extracted Number String = "1.8%"

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

NumStrProfileDto    - If successful, this method will return a type 'NumStrProfileDto'
                      populated with the extracted number string and additional profile
                      information related to the extracted number string.

   type NumStrProfileDto struct {

         TargetStr            string   //  The original target string which is scanned for a
                                       //    number string

         TargetStrStartIndex  int      //  The starting index in 'TargetStr' from which the
                                       //    number string search was initiated.

         LeadingSignIndex     int      //  The string index of a leading sign in 'NumStr' below. If a
                                       //    leading sign character is NOT present in 'NumStr' this
                                       //    value is set to -1

         LeadingSignChar      string   //  If a leading sign character (plus '+' or minus '-')
                                       //    exists in data field 'NumStr' (below), it is stored
                                       //    in this string.

         FirstNumCharIndex    int      //  The index in 'TargetStr' (above) where the first character
                                       //    of the extracted number string is located.

         NextTargetStrIndex   int      //  The index of the next character in 'TargetStr' immediately
                                       //    following the extracted number string.

         NumStrLen            int      //  The length of the extracted number string.

         NumStr               string   //  The number string extracted from 'TargetStr'.
   }

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If 'startIndex' is less than zero or if 'startIndex'
     exceeds the last character index in 'targetStr', an error
     will be returned.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

ePrefix := "TestStrOps_ExtractNumericDigits_06() "
targetStr := "Hello World! Your bank account =$(1,250,364.33).44 What do you think?"
startIndex := 0
keepLeadingChars := "$("
keepInteriorChars := ",."
keepTrailingChars := ")"

nStrDto,
err :=
  StrMech{}.Ptr().
       ExtractNumericDigits(
           targetStr,
           startIndex,
           keepLeadingChars,
           keepInteriorChars,
           keepTrailingChars,
           ePrefix)

----------------------------------------

nStrDto.NumStr is now equal to:
   "$(1,250,364.33)"

func (*StrMech) FindFirstNonSpaceChar ¶

func (sMech *StrMech) FindFirstNonSpaceChar(
	targetStr string,
	startIndex,
	endIndex int,
	errorPrefix interface{}) (
	int,
	error)

FindFirstNonSpaceChar - Returns the string index of the first non-space character in a string segment. The string to be searched is input parameter 'targetStr'. The string segment which will be searched from left to right in 'targetStr' is defined by the starting index ('startIndex') and the ending index ('endIndex').

Searching from left to right, this method identifies the first non-space character (any character that is NOT a space ' ') in the target string segment and returns the index associated with that non-space character.

------------------------------------------------------------------------

Input Parameters

targetStr           string
   - The string to be searched for the first non-space character.

startIdx            int
   - Since the search is forwards from left to right, this is
     the starting index for the search.

endIdx              int
   - Since the search is forwards from left to right, this is
     the ending index for the search.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

int
   - This method returns the index of the first non-space
     character in the target string segment using a left
     to right search. If the target string is an empty string
     or consists of entirely of space characters, this method
     returns a value of minus one (-1).

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the input parameter
     'errorPrefix' (error prefix) will be inserted or prefixed
     at the beginning of the error message.

func (*StrMech) FindLastNonSpaceChar ¶

func (sMech *StrMech) FindLastNonSpaceChar(
	targetStr string,
	startIdx int,
	endIdx int,
	errorPrefix interface{}) (
	int,
	error)

FindLastNonSpaceChar - Returns the string index of the last non-space character in a string segment. The string to be searched is input parameter, 'targetStr'. The string segment is further defined by input parameters 'startIdx' and 'endIdx'. These indexes define a segment within 'targetStr' which will be searched to identify the last non-space character.

The search is a backwards search, from right to left, conducted within the defined 'targetStr' segment. The search therefore starts at 'endIdx' and proceeds towards 'startIdx' until the last non-space character in the string segment is identified.

If the last non-space character is found, that string index is returned. If the string segment consists entirely of space characters, the return value is -1.

if 'targetStr' is a zero length string, an error will be triggered. Likewise, if 'startIdx' of 'endIdx' are invalid, an error will be returned.

------------------------------------------------------------------------

Input Parameters

targetStr           string
   - The string to be searched for the last non-space character.

startIdx            int
   - Since the search is backwards from right to left, this is
     the ending index for the search.

endIdx              int
   - Since this is a backwards search from right to left, this
     is actually the starting index for the search.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

int
   - The index of the last non-space character in input
     parameter 'targetStr' within the range specified by
     the staring and ending indexes.

     If all the characters within the specified range are
     space characters, this parameter returns a value of
     minus one (-1).

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the input parameter
     'errorPrefix' (error prefix) will be inserted or prefixed
     at the beginning of the error message.

func (*StrMech) FindLastSpace ¶

func (sMech *StrMech) FindLastSpace(
	targetStr string,
	startIdx int,
	endIdx int,
	errorPrefix interface{}) (
	int,
	error)

FindLastSpace - Returns a string index indicating the last space character (' ') in a string segment. The string segment is defined by input parameters, 'startIdx' and 'endIdx'.

The string segment search proceeds backwards, from right to left. The search therefore starts at 'endIdx' and proceeds towards 'startIdx' until the last space character in the string segment is identified.

If a valid index for the last space character is found in the string segment, that index value is returned. If a space character is NOT found in the specified string segment, a value of -1 is returned.

if 'targetStr' is a zero length string, an error will be triggered. Likewise, if 'startIdx' of 'endIdx' are invalid, an error will be returned.

------------------------------------------------------------------------

Input Parameters

targetStr           string
   - The string segment to be searched for the last space
     character resides in this string.

startIdx            int
   - Defines the actual ending index for the string segment to
     be searched. The search is a 'backwards' search and
     proceeds from right to left. Therefore, the starting point
     for the string segment is input parameter 'endIdx' while
     the ending point for the string segment is this 'startIdx'.

endIdx              int
   - Defines the actual beginning index of the string segment
     to be searched. The search is a 'backwards' search and
     proceeds from right to left. Therefore, the starting point
     for the string segment is defined by this 'endIdx'
     parameter while the ending point for the string segment is
     marked by the input parameter, 'startIdx'.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

int
   - If this method completes successfully, this returned
     integer value will constitute the string index of the last
     space character in the string segment marked by input
     parameters 'startIdx' and 'endIdx'.

     If a space character is NOT found in the specified string
     segment, a value of minus one (-1) is returned.

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the input parameter
     'errorPrefix' (error prefix) will be inserted or prefixed
     at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

               012345678901234
     testStr := "xx       Hxgltx"

     lastSpaceIdx, err :=
     StrMech{}.Ptr().FindLastSpace(
     testStr,
     0,
     14,
     ePrefix)

lastSpaceIdx is now equal to '8'

func (*StrMech) FindLastWord ¶

func (sMech *StrMech) FindLastWord(
	targetStr string,
	startIndex,
	endIndex int,
	errorPrefix interface{}) (
	beginWrdIdx,
	endWrdIdx int,
	isAllOneWord,
	isAllSpaces bool,
	err error)

FindLastWord - Returns the beginning and ending indexes of the last word in a target string segment. A 'word' is defined here as a contiguous set of non-space characters delimited by spaces or the beginning and ending indexes of the target string segment. Note, for purposes of this method, a 'word' my consist of a single non-space character such as an article 'a' or a punctuation mark '.'

------------------------------------------------------------------------

Examples

Example (1)
  In the text string segment:

  "The cow jumped over the moon."

  The last word would be defined as "moon."

  Example (2)
    In the text string segment:

    "  somewhere over the rainbow  "

    The last word would be defined as "rainbow"

------------------------------------------------------------------------

The string to be searched is contained in input parameter, 'targetStr'. The string segment within 'targetStr' is defined by input parameters 'startIndex' and 'endIndex'.

If the entire string segment is classified as a 'word', meaning that there are no space characters in the string segment, the returned values for 'beginWrdIdx' and 'endWrdIdx' will be equal to the input parameters 'startIndex' and 'endIndex'.

If the string segment is consists entirely of space characters, the returned 'beginWrdIdx' and 'endWrdIdx' will be set equal to -1 and the returned value, 'isAllSpaces' will be set to 'true'.

If 'targetStr' is an empty string, an error will be returned.

------------------------------------------------------------------------

Input Parameters

targetStr           string
   - The string containing the string segment which
     will be searched to identify the last word
     in the string segment.

startIndex          int
   - The index marking the beginning of the string
     segment in 'targetStr'.

endIndex       int
   - The index marking the end of the string segment
     in 'targetStr'.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

beginWrdIdx         int
   - The index marking the beginning of the last word
     in the string segment identified by input parameters
     'startIndex' and 'endIndex'. If the string segment
     consists of all spaces or is empty, this value is
     set to -1.

endWrdIdx           int
   - The index marking the end of the last word in the
     string segment identified by input parameters 'startIndex'
     and 'endIndex'. If the string segment consists of all
     spaces or is empty, this value is set to -1.

isAllOneWord        bool
   - If the string segment identified by input parameters
     'startIndex' and 'endIndex' consists entirely of non-space
     characters (characters other than ' '), this value is set
     to 'true'.

isAllSpaces         bool
   - If the string segment identified by input parameters
     'startIndex' and 'endIndex' consists entirely of space
     characters (character = ' '), this value is set to 'true'.

err                 error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the input parameter
     'errorPrefix' (error prefix) will be inserted or prefixed
     at the beginning of the error message.

func (*StrMech) FindRegExIndex ¶

func (sMech *StrMech) FindRegExIndex(
	targetStr string,
	regex string) []int

FindRegExIndex - returns a two-element slice of integers defining the location of the leftmost match in targetStr of the regular expression (regex).

------------------------------------------------------------------------

Return Value ¶

The return value is an array of integers. If no match is found the return value is 'nil'. If regular expression is successfully matched, the match will be located at targetStr[loc[0]:loc[1]]. Again, a return value of 'nil' signals that no match was found.

func (*StrMech) GetReader ¶

func (sMech *StrMech) GetReader() io.Reader

GetReader - Returns an io.Reader which will read the private member data element StrMech.stringData.

func (*StrMech) GetStringData ¶

func (sMech *StrMech) GetStringData() string

GetStringData - Returns the current value of internal member string, StrMech.stringData

func (*StrMech) GetValidBytes ¶

func (sMech *StrMech) GetValidBytes(
	targetBytes,
	validBytes []byte,
	errorPrefix interface{}) ([]byte, error)

GetValidBytes - Receives an array of 'targetBytes' which will be examined to determine the validity of individual bytes or characters. Each character (byte) in input array 'targetBytes' will be compared to input parameter 'validBytes', another array of bytes. If a character in 'targetBytes' also exists in 'validBytes' it will be considered valid and included in the returned array of bytes.

------------------------------------------------------------------------

Input Parameters

targetBytes         [] byte
   - An array of characters (bytes) which will be examined
     for valid characters. The list of valid characters is
     found in input parameter 'validBytes'. Valid characters
     in targetBytes will be returned by this method as an
     array of bytes. Invalid characters will be discarded.

validBytes          [] byte
   - An array of bytes containing valid characters. If a character
     (byte) in 'targetBytes' is also present in 'validBytes' it will
     be classified as 'valid' and included in the returned array of
     bytes. Invalid characters will be discarded.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

[] byte
   - An array of bytes which contains bytes that are present in both 'targetBytes'
     and 'validBytes'. Note: If all characters in 'targetBytes' are classified as
     'invalid', the returned array of bytes will be a zero length array.

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

ePrefix := "TestStrOps_GetValidBytes_01() "
validBytes := []byte{'v', 'a', 'l', 'i', 'd'}
testBytes := []byte{'x', 'j', 'v', 'm', 'R', 'a', 'J', 'l', 'Z', 'i', 'F', 'd', 'S'}

actualBytes, err := StrMech{}.Ptr().GetValidBytes(
testBytes,
validBytes,
ePrefix)

'actualBytes' is now equal to "valid"

func (*StrMech) GetValidRunes ¶

func (sMech *StrMech) GetValidRunes(
	targetRunes []rune,
	validRunes []rune,
	errorPrefix interface{}) (
	[]rune,
	error)

GetValidRunes - Receives an array of 'targetRunes' which will be examined to determine the validity of individual runes or characters. Each character (rune) in input array 'targetRunes' will be compared to input parameter 'validRunes', another array of runes. If a character in 'targetRunes' also exists in 'validRunes', that character will be considered valid and included in the returned array of runes.

------------------------------------------------------------------------

Input Parameters

targetRunes         [] rune
   - An array of characters (runes) which will be examined
     for valid characters. The list of valid characters is
     found in input parameter 'validRunes'. Valid characters
     in targetRunes will be returned by this method as an
     array of runes. Invalid characters will be discarded.

validRunes          [] rune
   - An array of runes containing valid characters. If a character
     (rune) in targetRunes is also present in 'validRunes' it will
     be classified as 'valid' and included in the returned array of
     runes. Invalid characters will be discarded.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

[] rune
   - An array of runes which contains runes that are present in 'targetRunes' and
     'validRunes'. Note: If all characters in 'targetRunes' are classified as
     'invalid', the returned array of runes will be a zero length array.

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

ePrefix := "TestStrOps_GetValidRunes_01() "

validRunes := []rune{'v', 'a', 'l', 'i', 'd'}

testRunes := []rune{'x', 'j', 'v', 'm', 'R', 'a', 'J', 'l', 'Z', 'i', 'F', 'd', 'S'}

expected := "valid"

actualRunes, err := StrMech{}.Ptr().GetValidRunes(
testRunes,
validRunes,
ePrefix)

actualRunes is now equal to string(actualRunes) == "valid"

func (*StrMech) GetValidString ¶

func (sMech *StrMech) GetValidString(
	targetStr string,
	validRunes []rune,
	errorPrefix interface{}) (
	string,
	error)

GetValidString - Validates the individual characters in input parameter string, 'targetStr'. To identify valid characters, the characters in 'targetStr' are compared against input parameter 'validRunes', an array of type rune. If a character exists in both 'targetStr' and 'validRunes' it is deemed valid and returned in an output string.

------------------------------------------------------------------------

Input Parameter

targetStr           string
   - The string which will be screened for valid characters.

validRunes []rune
   - An array of type rune containing valid characters. Characters
     which exist in both 'targetStr' and 'validRunes' will be
     returned as a new string. Invalid characters are discarded.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

string
   - This string will be returned containing valid characters extracted
     from 'targetStr'. A character is considered valid if it exists in
     both 'targetStr' and 'validRunes'. Invalid characters are discarded.
     This means that if no valid characters are identified, a zero length
     string will be returned.

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

  ePrefix := "TestStrOps_GetValidString_01() "

  validRunes := []rune{'v', 'a', 'l', 'i', 'd'}

  testStr := "xjvmRaJlZiFdS"

  actualStr, err := StrMech{}.Ptr().GetValidString(
                      testStr,
                      validRunes,
                      ePrefix)

'actualStr' is now equal to "valid"

func (*StrMech) IsEmptyOrWhiteSpace ¶

func (sMech *StrMech) IsEmptyOrWhiteSpace(targetStr string) bool

IsEmptyOrWhiteSpace - If a string is zero length or consists solely of white space (contiguous spaces), this method will return 'true'.

Otherwise, a value of false is returned.

func (*StrMech) JustifyTextInStrField ¶

func (sMech *StrMech) JustifyTextInStrField(
	strToJustify string,
	fieldLen int,
	textJustify TextJustify,
	errorPrefix interface{}) (
	string,
	error)

JustifyTextInStrField - Creates a and returns a new string text field with text 'strToJustify' positioned inside that new string in accordance with the string justification formatting passed in input parameter, 'textJustify'.

'textJustify' will specify either 'Right-Justify', 'Left-Justify' or 'Center'. Based on this specification, the newly created and returned text string will contain 'strToJustify' properly formatted as 'Right-Justified', 'Left-Justified' or 'Centered'.

If the length of 'strToJustify' is greater than the output field length value, 'fieldLen', this method will increase the value of 'fieldLen' to match the length of 'strToJustify'.

------------------------------------------------------------------------

Input Parameters

strToJustify        string
  - The string content or text which will be positioned and
    formatted inside the returned output string according to
    the text justification specification contained in input
    parameter, 'textJustify'.

    If 'strToJustify' is a zero length empty string, this
    method will return a string of white-space characters
    equal in length to the value of input parameter,
    'fieldLen'.

fieldLen            int
   - The total length of the returned output string in which
     'strToJustify' will be positioned and formatted. If this
     'fieldLen' value is less than the length of 'strToJustify',
     'fieldLen' will be automatically increased to a value equal
     to the length of 'strToJustify'.

textJustify         TextJustify
   - An enumeration value used to specify the type of text
     formatting which will be applied to 'strToJustify' when
     it is positioned inside of the returned output string.
     This enumeration value must be one of the three following
     format specifications:

     1. Left   - Signals that the text justification format is
                 set to 'Left-Justify'. Strings within text
                 fields will be flush with the left margin.
                        Example: "TextString      "

     2. Right  - Signals that the text justification format is
                 set to 'Right-Justify'. Strings within text
                 fields will terminate at the right margin.
                        Example: "      TextString"

     3. Center - Signals that the text justification format is
                 is set to 'Centered'. Strings will be positioned
                 in the center of the text field equidistant
                 from the left and right margins.
                         Example: "   TextString   "

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

string
   - The output string resulting from the text justification
     operation described above. Input parameter, 'strToJustify'
     will be formatted in this output string according to the
     format specification defined by input parameter,
     'textJustify'. The length of this output string is
     controlled by input parameter, 'fieldLen'.

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

ePrefix := "TestStrOps_StrJustify_01() "
strToJustify := "12345"
fieldLen := 10

su := StrMech{}
strJustified, err :=
 su.justifyTextInStrField(
             strToJustify,
             fieldLen,
             TextJustify(0).Right()
             ePrefix)

--------------------------------------------------------
                                1234567890
'strJustified' is now equal to "     12345"
The string length of 'strJustified' is 10

func (*StrMech) LowerCaseFirstLetter ¶

func (sMech *StrMech) LowerCaseFirstLetter(str string) string

LowerCaseFirstLetter - Finds the first alphabetic character in a string (a-z A-Z) and converts it to lower case.

func (*StrMech) MakeSingleCharString ¶

func (sMech *StrMech) MakeSingleCharString(
	charRune rune,
	strLen int,
	errorPrefix interface{}) (
	string,
	error)

MakeSingleCharString - Creates a string of length 'strLen' consisting of a single character passed through input parameter, 'charRune' as type 'rune'.

Example Usage:

sUtil := StrMech{}
requestedLen := 5
charRune := '='
outputStr, err := sUtil.MakeSingleCharString(charRune, requestedLen)

outputStr is now equal to "====="

------------------------------------------------------------------------

Input Parameters

charRune            rune
   - The text character which will be repeated throughout the
     length of the returned string.

strLen              int
   - The length of the returned string containing the repeated
     characters.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

string
   - This returned string will have a length of 'strLen' and
     contain 'strLen' characters all of which will be equal to
     'charRune'.

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

func (StrMech) NewPtr ¶

func (sMech StrMech) NewPtr() *StrMech

NewPtr - Returns a pointer to a new instance of StrMech. Useful for cases requiring io.Reader and io.Writer.

func (StrMech) Ptr ¶

func (sMech StrMech) Ptr() *StrMech

Ptr - Returns a pointer to a new instance of StrMech. Useful for cases requiring io.Reader and io.Writer.

This method is identical to method StrMech.NewPtr().

Example Usage:

StrMech{}.Ptr().GetReader()

func (*StrMech) Read ¶

func (sMech *StrMech) Read(p []byte) (n int, err error)

Read - Implements io.Reader interface. Read reads up to len(p) bytes into 'p'. This method supports buffered 'read' operations.

The internal member string variable, 'StrMech.stringData' is written into 'p'. When the end of 'StrMech.stringData' is written to 'p', the method returns error = 'io.EOF'.

'StrMech.stringData' can be accessed through Getter an Setter methods, GetStringData() and SetStringData()

func (*StrMech) ReadStringFromBytes ¶

func (sMech *StrMech) ReadStringFromBytes(
	bytes []byte,
	startIdx int) (
	extractedStr string,
	nextStartIdx int)

ReadStringFromBytes - Receives a byte array and retrieves a string. The beginning of the string is designated by input parameter 'startIdx'. The end of the string is determined when a carriage return ('\r'), vertical tab ('\v') or a new line character ('\n') is encountered.

The parsed string is returned to the caller along with 'nextStartIdx', which is the byte array index of the beginning of the next string.

------------------------------------------------------------------------

Input Parameters

bytes               []byte
   - An array of bytes from which a string will be extracted
     and returned.

startIdx            int
   - The starting index in input parameter 'bytes' where the string
     extraction will begin. The string extraction will cease when
     a carriage return ('\r'), a vertical tab ('\v') or a new line
     character ('\n') is encountered.

------------------------------------------------------------------------

Return Values

extractedStr        string
   - The string extracted from input parameter 'bytes' beginning
     at the index in 'bytes' indicated by input parameter 'startIdx'.

nextStartIdx        int
   - The index of the beginning of the next string in the byte array
     'bytes' after 'extractedString'. If no more strings exist in the
     the byte array, 'nextStartIdx' will be set to -1.

func (*StrMech) RemoveStringChar ¶

func (sMech *StrMech) RemoveStringChar(
	targetStr string,
	charToRemove rune,
	maxNumOfCharDeletions int,
	errorPrefix interface{}) (
	newStr string,
	numOfDeletions int,
	err error)

RemoveStringChar - Removes or deletes a specified character from a string and returns a new string.

----------------------------------------------------------------

Input Parameters

targetStr                  string
   - The target string containing the character to be removed.
     If this is a zero length or empty string, an error will
     be returned.

charToRemove               rune
   - The character which will be removed from 'targetStr'. If
     this is an empty character or zero value rune, an error
     will be returned.

maxNumOfCharDeletions      int
   - If this parameter is set to minus one (-1), all instances
     of 'charToRemove' in 'targetStr' will be deleted in the
     returned string. If this parameter is greater than zero,
     it will limit the maximum number of character deletions
     in this operation. Remember that the search for
     'charToRemove' proceeds from left to right starting at
     index zero (0).

     If this parameter is set to zero, an error will be
     returned.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

-----------------------------------------------------------------

Return Values

newStr                     string
   - If this method completes successfully, a new string
     will be returned containing all the characters in
     input parameter 'targetStr' except those removed by
     the deletion operation.

numOfDeletions             int
   - This parameter will record the number of character
     deletions performed by this operation.

err                        error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

func (*StrMech) ReplaceBytes ¶

func (sMech *StrMech) ReplaceBytes(
	targetBytes []byte,
	replacementBytes [][]byte,
	errorPrefix interface{}) (
	[]byte,
	error)

ReplaceBytes - Replaces characters in a target array of bytes ([]bytes) with those specified in a two dimensional slice of bytes.

------------------------------------------------------------------------

Input Parameters

targetBytes         []byte
   - The byte array which will be examined. If characters ('bytes') eligible
     for replacement are identified by replacementBytes[i][0] they will be
     replaced by the character specified in replacementBytes[i][1].

replacementBytes    [][]byte
   - A two dimensional slice of type byte. Element [i][0] contains the
     target character to locate in 'targetBytes'. Element[i][1] contains
     the replacement character which will replace the target character
     in 'targetBytes'. If the replacement character element [i][1] is
     a zero value, the target character will not be replaced. Instead,
     it will be eliminated or removed from the returned byte array ([]byte).

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

[]byte
   - The returned byte array containing the characters and replaced characters
     from the original 'targetBytes' array.

err                 error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

testStr := "1a2b3c4d5e6"
testBytes := []byte(testStr)

replaceBytes := make([][]byte, 5, 10)

for i := 0; i < 5; i++ {
 replaceBytes[i] = make([]byte, 2, 5)
}

replaceBytes[0][0] = 'a'
replaceBytes[0][1] = 'A'

replaceBytes[1][0] = 'b'
replaceBytes[1][1] = 'B'

replaceBytes[2][0] = 'c'
replaceBytes[2][1] = 'C'

replaceBytes[3][0] = 'd'
replaceBytes[3][1] = 'D'

replaceBytes[4][0] = 'e'
replaceBytes[4][1] = 'E'

ePrefix := "TestStrOps_ReplaceBytes_01() "

actualRunes, err := StrMech{}.Ptr().ReplaceBytes(
testBytes,
replaceBytes,
ePrefix)

actualRunes = "1A2B3C4D5E6"

func (*StrMech) ReplaceMultipleStrs ¶

func (sMech *StrMech) ReplaceMultipleStrs(
	targetStr string,
	replaceArray [][]string,
	errorPrefix interface{}) (
	string,
	error)

ReplaceMultipleStrs - Replaces all instances of string replaceArray[i][0] with replacement string from replaceArray[i][1] in 'targetStr'.

Input parameter 'replaceArray' should be passed as a two-dimensional slice. If the length of the 'replaceArray' second dimension is less than '2', an error will be returned.

------------------------------------------------------------------------

Input Parameters

targetStr           string
   - The parent or host string which will be searched for
     instances of sub-string replaceArray[i][0]. Instances of
     this string found in 'targetStr' will be replaced with the
     string from replaceArray[i][1].

replaceArray        [][]string
   - A two dimensional array of type 'string'. 'targetStr' will
     be searched for instances of replaceArray[i][0]. If found
     in 'targetStr' this string will be replaced with the string
     from replaceArray[i][1].

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

string
   - This is the 'result' string. It is identical to 'targetStr'
     except for the string substitutions made from replaceArray[i][1].

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

ePrefix := "TestStrOps_ReplaceMultipleStrs_08() "
rStrs := make([][]string, 3, 5)

for i := 0; i < 3; i++ {
 rStrs[i] = make([]string, 2, 5)
}

testStr := "HeFFxJWxrFd"

rStrs[0][0] = "x"
rStrs[0][1] = "o"
rStrs[1][0] = "J"
rStrs[1][1] = " "
rStrs[2][0] = "F"
rStrs[2][1] = "l"

actualStr, err := StrMech{}.Ptr().ReplaceMultipleStrs(
                    testStr,
                    rStrs,
                    ePrefix)

'actualStr' is now equal to "Hello World"

func (*StrMech) ReplaceNewLines ¶

func (sMech *StrMech) ReplaceNewLines(
	targetStr string,
	replacementStr string) string

ReplaceNewLines - Replaces New Line characters from string. If the specified replacement string is empty, the New Line characters are simply removed from the input parameter, 'targetStr'.

----------------------------------------------------------------

Input Parameters

targetStr                  string
   - The target string containing the new line characters to be
     removed. If this is a zero length or empty string, no action
     will be taken.

replacementStr             string
   - The string which will replace the new line character. If
     this parameter is an empty string, the new line characters
     will simply be deleted from the returned string.

-----------------------------------------------------------------

Return Values

string
   - The returned string which contains substitutions of
     'replacementStr' for the new line character in
     'targetStr'.

func (*StrMech) ReplaceRunes ¶

func (sMech *StrMech) ReplaceRunes(
	targetRunes []rune,
	replacementRunes [][2]rune,
	errorPrefix interface{}) (
	[]rune,
	error)

ReplaceRunes - Replaces individual characters in a target array of runes ([]rune) with those specified in a two-dimensional slice of runes, 'replacementRunes[][]'.

------------------------------------------------------------------------

Input Parameters

targetRunes         []rune
   - The rune array which will be examined. If target characters
     ('runes') eligible for replacement are identified by
     replacementRunes[i][0], they will be replaced by the
     character specified in replacementRunes[i][1].

replacementRunes    [][2]rune
   - A two dimensional slice of type 'rune'. Element [i][0]
     contains the target character to locate in 'targetRunes'.
     Element[i][1] contains the replacement character which will
     replace the target character in 'targetRunes'. If the
     replacement character element [i][1] is a zero value, the
     target character will not be replaced. Instead, it will be
     eliminated or removed from the returned rune array
     ([]rune).

     If 'replacementRunes' is nil or a zero length array, this
     method will return an error.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

[]rune
   - The returned rune array containing the characters and
     replaced characters from the original 'targetRunes' array.

error
   - If the method completes successfully this value is 'nil'.
     If an error is encountered this value will contain the
     error message. Examples of possible errors include a zero
     length 'targetRunes' array or 'replacementRunes' array.

     In addition, if any of the replacementRunes[][x] 2nd
     dimension elements have a length less than two, an
     error will be returned.

------------------------------------------------------------------------

Example Usage

ePrefix := "TestStrOps_ReplaceRunes_02() "

testStr := "1a2b3c4d5e6"
testRunes := []rune(testStr)

replaceRunes := make([][]rune, 5, 10)

for i := 0; i < 5; i++ {
  replaceRunes[i] = make([]rune, 2, 5)
}

replaceRunes[0][0] = 'a'
replaceRunes[0][1] = 0

replaceRunes[1][0] = 'b'
replaceRunes[1][1] = 0

replaceRunes[2][0] = 'c'
replaceRunes[2][1] = 0

replaceRunes[3][0] = 'd'
replaceRunes[3][1] = 0

replaceRunes[4][0] = 'e'
replaceRunes[4][1] = 0

actualRunes, err := StrMech{}.Ptr().ReplaceRunes(
testRunes,
replaceRunes,
ePrefix)

actualStr := string(actualRunes)
--------------------------------------
Original testStr := "1a2b3c4d5e6"
actualStr is now equal to "123456"

func (*StrMech) ReplaceStringChar ¶

func (sMech *StrMech) ReplaceStringChar(
	targetStr string,
	charToReplace rune,
	replacementChar rune,
	maxNumOfReplacements int,
	errorPrefix interface{}) (
	string,
	int,
	error)

ReplaceStringChar - Replaces a specific character found anywhere in a string with another specified substitute character.

The replacement operation proceeds from left to right within the 'targetStr' beginning with index zero (0).

------------------------------------------------------------------------

Input Parameters

targetStr                  string
   - The string containing the character to be replaced.
     If this is an empty string, an error will be returned.

charToReplace              rune
   - The character within input parameter string 'targetStr'
     which will be replaced. If this parameter is set to zero
     signaling an empty character, this method will return an
     error.

replacementChar            rune
   - The character which will replace 'charToReplace' in
     'targetStr'. If this parameter is set to zero signaling an
     empty character, this method will return an error.

maxNumOfReplacements       int
   - The maximum number of replacements allowed for this
     operation. If this parameter is set to minus one (-1), all
     instances of 'charToReplace' in 'targetStr' will be
     replaced with 'replacementChar'.

     If this parameter is set to zero ('0'), an error will be
     returned.

     The replacement operation proceeds from left to right
     within the 'targetStr' beginning with index zero (0).

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

string
   - If this method completes successfully, a new string will be
     returned with the designated replacement characters.

int
   - The integer value records the number of characters
     replaced in 'targetStr'.

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

func (*StrMech) ReplaceStringChars ¶

func (sMech *StrMech) ReplaceStringChars(
	targetStr string,
	replacementRunes [][2]rune,
	errorPrefix interface{}) (
	string,
	error)

ReplaceStringChars - Replaces string characters in a target string ('targetStr') with those specified in a two dimensional slice of runes, 'replacementRunes[][]'.

------------------------------------------------------------------------

Input Parameters

targetStr           string
   - The string which will be examined. If target string characters
     eligible for replacement are identified by replacementRunes[i][0],
     they will be replaced by the character specified in
     replacementRunes[i][1].

replacementRunes    [][2]rune
   - A two dimensional slice of type 'rune'. Element [i][0] contains
     the target character to locate in 'targetStr'. Element[i][1]
     contains the replacement character which will replace the target
     character in 'targetStr'. If the replacement character
     element [i][1] is a zero value, the target character will not
     be replaced. Instead, it will be eliminated or removed from the
     returned string.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

string
   - The returned string containing the characters and replaced characters
     from the original target string, ('targetStr').

error
   - If the method completes successfully this value is 'nil'. If an error is
     encountered this value will contain the error message. Examples of possible
     errors include a zero length 'targetStr' or 'replacementRunes[][]' array.
     In addition, if any of the replacementRunes[][x] 2nd dimension elements have
     a length less than two, an error will be returned.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

ePrefix := "TestStrOps_ReplaceStringChars_06() "

testStr := "1a2b3c4d5e6"

replaceRunes := make([][]rune, 5, 10)

for i := 0; i < 5; i++ {
replaceRunes[i] = make([]rune, 2, 5)
}

replaceRunes[0][0] = 'a'
replaceRunes[0][1] = 0

replaceRunes[1][0] = 'b'
replaceRunes[1][1] = 0

replaceRunes[2][0] = 'c'
replaceRunes[2][1] = 0

replaceRunes[3][0] = 'd'
replaceRunes[3][1] = 0

replaceRunes[4][0] = 'e'
replaceRunes[4][1] = 0

actualStr, err := StrMech{}.Ptr().ReplaceStringChars(
testStr,
replaceRunes,
ePrefix)

---------------------------------------------------
Original testStr := "1a2b3c4d5e6"

actualStr is now equal to = "123456"

func (*StrMech) SetStringData ¶

func (sMech *StrMech) SetStringData(str string)

SetStringData - Sets the value of internal string data element, StrMech.stringData. It also zeros internal fields sops.cntBytesWritten and sops.cntBytesRead.

func (*StrMech) StrCenterInStr ¶

func (sMech *StrMech) StrCenterInStr(
	strToCenter string,
	fieldLen int,
	errorPrefix interface{}) (string, error)

StrCenterInStr - returns a string which includes a left pad blank string plus the original string ('strToCenter'), plus a right pad blank string.

The returned string will effectively center the original string ('strToCenter') in a field of specified length ('fieldLen').

------------------------------------------------------------------------

Input Parameters

strToCenter         string
   - This string will be centered in a text field. The text
     field length is defined by input parameter, 'fieldLen'.

fieldLen            int
   - Defines the length of a text field in which 'strToCenter'
     will be centered.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

string
   - This returned string contains 'strToCenter' with the
     necessary left-pad and right-pad number of spaces
     required for centering. The total length of this string
     will be equal to input parameter, 'fieldLen'.

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

error
   - If this method completes successfully, the returned error
     Type is set equal to 'nil'. If errors are encountered during
     processing, the returned error Type will encapsulate an error
     message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

ePrefix := "TestStrOps_StrCenterInStr_02() "
strToCenter := "Hello"
fieldLen := 15

su := StrMech{}
centeredStr, err := su.StrCenterInStr(
strToCenter,
fieldLen,
ePrefix)

---------------------------------------------
                             123456789012345
centeredStr is now equal to "     Hello     "
'Hello' is centered in a field of length 15
with left and right pad of 5-spaces.

func (*StrMech) StrCenterInStrLeft ¶

func (sMech *StrMech) StrCenterInStrLeft(
	strToCenter string,
	fieldLen int,
	errorPrefix interface{}) (
	string,
	error)

StrCenterInStrLeft - returns a string which includes a left pad blank string plus the original string. It does NOT include the Right pad blank string.

Nevertheless, the complete string will effectively center the original string in a field of specified length.

------------------------------------------------------------------------

Input Parameters

strToCenter         string
   - This string will be centered in a text field. The text
     field length is defined by input parameter, 'fieldLen'.

fieldLen            int
   - Defines the length of a text field in which 'strToCenter'
     will be centered.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

string
   - This returned string contains 'strToCenter' with the
     necessary left-pad number of spaces required for
     centering.

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

In this example the total field length is 15. The length of the
test string, "Hello", is 5. In order to center the test string
in a field with length of 15, there will be 5-spaces on the
left and 5-spaces on the right. This method will compute the
left-pad spaces necessary to center the string in a field with
length of 15, but will only include the padded left margin of
5-spaces. It will NOT include the trailing 5-spaces on the
right.

In the following example, the final result string will
substitute the'@' character for the white space character
(0x20) in order to illustrate the padding added by this method.

 strToCenter     = "Hello"
 fieldLen        = 15
 Returned String = "@@@@@Hello" or "     Hello"

func (*StrMech) StrGetCharCnt ¶

func (sMech *StrMech) StrGetCharCnt(
	targetStr string) int

StrGetCharCnt - Uses the 'len' method to return the number of rune characters in a string.

func (*StrMech) StrGetRuneCnt ¶

func (sMech *StrMech) StrGetRuneCnt(
	targetStr string) int

StrGetRuneCnt - Uses utf8 Rune Count function to return the number of characters in a string.

func (*StrMech) StrLeftJustify ¶

func (sMech *StrMech) StrLeftJustify(
	strToJustify string,
	fieldLen int,
	errorPrefix interface{}) (
	string,
	error)

StrLeftJustify - Creates a new string, left-justified, within a with a wider text field or output string. The text to be left justified is specified by input parameter 'strToJustify'. The length of the output string is defined by input parameter, 'fieldLen'.

Input parameter 'strToJustify' is placed on the left side of the output string and spaces are padded to the right in order to create a string with total length of 'fieldLen'.

------------------------------------------------------------------------

Input Parameters

strToJustify        string
   - The text content which will be left-justified in the
     output string returned by this method.

fieldLen            int
   - Defines the length of the output string in which input
     parameter 'strToJustify' will be left-justified.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

string
   - The output string resulting from the 'left-justify'
     operation. Input parameter, 'strToJustify' will be
     left-justified in this output string which will have a
     total string length as defined by input parameter,
     'fieldLen'.

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

ePrefix := "TestStrOps_StrLeftJustify_01() "
fieldLen = 15
strToJustify    = "Hello World"
su := StrMech{}
justifiedStr, err := su.StrLeftJustify(
                         strToJustify,
                         fieldLen,
                         ePrefix)

------------------------------------------------
                                123456789012345
'justifiedStr' is now equal to "Hello World    "
The string length of 'justifiedStr' is 15

func (*StrMech) StrPadLeftToCenter ¶

func (sMech *StrMech) StrPadLeftToCenter(
	strToCenter string,
	fieldLen int,
	errorPrefix interface{}) (string, error)

StrPadLeftToCenter - Returns a blank string which allows centering of the target string in a fixed length field. A blank string is defined here as a string consisting entirely of white space characters (' ' 0x20). This string can be prefixed or added to the beginning of a text string to achieve a centering effect when displayed.

Therefore the blank string returned by this method only constitutes the left-padding of white space necessary to center the input parameter, 'strToCenter'. It does not include the right padding of white space.

------------------------------------------------------------------------

Input Parameters

strToCenter         string
  - The content or text string which will be centered.

fieldLen            int
   - The total length of the text field in which 'strToCenter'
     will be centered.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

string
   - The output string resulting from the string centering
     operation. This string will consist entirely of white
     space (' ' 0x20 characters). It will represent the left
     padding necessary to center the text string,
     'strToCenter'. See 'Example Usage' section below.

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage ¶

Assume that total field length ('fieldlen') is 70. Further assume that the string to Center ('strToCenter') is 10-characters in length. In order to center a 10-character string in a 70-character field, 30-space characters would need to be positioned on each side of the string to center. This method only returns the left margin, or in this example, a string consisting of 30-spaces.

ePrefix := "TestStrOps_StrPadLeftToCenter_02() "
//              12345
strToCenter := "Hello"
fieldLen := 15
su := StrMech{}
padStr, err := su.StrPadLeftToCenter(
                 strToCenter,
                 fieldLen,
                 ePrefix)

-------------------------------------------------------------
                        12345
'padStr' is now equal to "     "
'padStr' consists of 5-spaces.
padStr + strToCenter will yield a centered string.

func (*StrMech) StrRightJustify ¶

func (sMech *StrMech) StrRightJustify(
	strToJustify string,
	fieldLen int,
	errorPrefix interface{}) (
	string,
	error)

StrRightJustify - Creates a new string, right-justified, within a wider text field or output string. The text to be right justified is specified by input parameter 'strToJustify'. The length of the output string is defined by input parameter, 'fieldLen'.

Input parameter 'strToJustify' is placed on the right side of the output string and spaces are padded to the left in order to create a string with total length of 'fieldLen'.

------------------------------------------------------------------------

Input Parameters

strToJustify        string
  - The content or text string which will be right justified.

fieldLen            int
   - The total length of the text field in which 'strToCenter'
     will be right-justified.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

string
   - The output string resulting from the 'right-justify'
     operation. Input parameter, 'strToJustify' will be
     right-justified in this output string which will have a
     total string length as defined by input parameter,
     'fieldLen'.

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

If the total field length ('fieldLen') is specified as
10-characters and the length of string to justify
('strToJustify') is 5-characters, then this method would return
a string consisting of 5-space characters plus the
'strToJustify'.

ePrefix := "TestStrOps_StrRightJustify_05() "
strToJustify := "12345"
fieldLen := 10

su := StrMech{}
strRightJustified, err :=
 su.StrRightJustify(
             strToJustify,
             fieldLen,
             ePrefix)

--------------------------------------------------------
                                     1234567890
'strRightJustified' is now equal to "     12345"
The string length of 'strRightJustified' is 10

func (*StrMech) StripBadChars ¶

func (sMech *StrMech) StripBadChars(
	targetStr string,
	badChars []string) (
	cleanStr string,
	strLen int)

StripBadChars - Removes/deletes specified sub-strings from a parent or host string. The targeted sub-strings are deleted wherever found in the parent or host string.

The sub-strings to be removed are identified in a string array passed as input parameter, 'badChars'.

All instances of 'badChars' sub-strings are deleted from the target string which is passed as input parameter, 'targetStr'.

------------------------------------------------------------------------

Input Parameters

targetStr           string
   - The string which will be searched for the sub-strings
     identified in the 'badChars' array for deletion.

badChars            []string
   - A one dimensional array of strings which contains the
     sub-strings to be deleted from input parameter,
     'targetStr'.

------------------------------------------------------------------------

Return Values

cleanStr            string
   - This returned string is a copy of 'targetStr' minus the
     sub-strings identified in the 'badChars' array which are
     deleted.

strLen              int
   - This integer value contains the length of the newly
     generated, 'cleanStr', described above.

------------------------------------------------------------------------

Example Usage

 badChars := []string{"@@"}

 expectedStrLen := len(expectedStr)
                12    123456789    12  12
 testString := "@@Some@@@@@@@@@Stri@@ng@@"

 actualString, actualStrLen :=
       StrMech{}.Ptr().StripBadChars(
                          testString,
                          badChars)

-----------------------------------------------
                               12345678901
 actualString is now equal to "Some@String"
 actualStrLen is now equal to 11

func (*StrMech) StripLeadingChars ¶

func (sMech *StrMech) StripLeadingChars(
	targetStr string,
	badChars []string) (
	cleanStr string,
	strLen int)

StripLeadingChars - Strips or deletes sub-strings from the front of a parent or host string labeled here as 'targetStr'. The sub-strings to be deleted are specified by input parameter and string array, 'badChars'.

The method then returns a string which does not contain leading sub-strings identified in the 'badChars' array. In addition, the length of the final 'clean string' is also returned.

------------------------------------------------------------------------

Input Parameters

targetStr           string
   - The string which will be searched for leading sub-strings
     identified in the 'badChars' array for deletion.

badChars            []string
   - A one dimensional array of strings which contains the
     sub-strings to be deleted from input parameter,
     'targetStr'.

------------------------------------------------------------------------

Return Values

cleanStr            string
   - This returned string is a copy of 'targetStr' minus the
     sub-strings identified in the 'badChars' array which are
     deleted from the front of 'targetStr'.

strLen              int
   - This integer value contains the length of the newly
     generated, 'cleanStr', described above.

------------------------------------------------------------------------

Example Usage

badChars := []string{
               " ", // A single white-space character
               "/",
               "//",
               "\\\\",
               "\\",
               ".\\",
               "../",
               ".",
               "..\\",
               "\\\\\\",
               "..",
               "./",
               "//",
               "///",
               "////",
               "..."}

testString :=
 "..........      ./../.\\.\\..\\////   SomeString"

actualString, actualStrLen :=
    StrMech{}.Ptr().StripLeadingChars(
                     testString,
                     badChars)

----------------------------------------------------
                              1234567890
actualString is now equal to "SomeString"
actualStrLen is now equal to 10

func (*StrMech) StripTrailingChars ¶

func (sMech *StrMech) StripTrailingChars(
	targetStr string,
	badChars []string) (cleanStr string, strLen int)

StripTrailingChars - Strips or deletes sub-strings from the end of a parent or host string. The sub-strings to be deleted are identified in a string array input parameter labeled, 'badChars'. The parent string to be searched is passed as input parameter, 'targetStr'. The targeted sub-strings are only deleted if they exist at the end of 'targetStr'.

Upon completion, this method returns the cleaned string and the length of the cleaned string to the caller. The cleaned string is equivalent to input parameter, 'targetStr', minus the trailing sub-strings identified by string array 'badChars'.

------------------------------------------------------------------------

Input Parameters

targetStr           string
   - The parent or host string which will be searched for
     instances of trailing sub-strings identified in the
     'badChars' string array for deletion.

badChars            []string
   - A one dimensional array of strings which contains the
     sub-strings to be deleted from the end of 'targetStr'.

------------------------------------------------------------------------

Return Values

cleanStr            string
   - This returned string is a copy of 'targetStr' minus the
     trailing sub-strings identified for deletion in the
     'badChars' array.

strLen              int
   - This integer value contains the length of the newly
     generated, 'cleanStr', described above.

------------------------------------------------------------------------

Example Usage

badChars := []string{
               " ", // Single white space character
               "/",
               "//",
               "\\\\",
               "\\",
               ".\\",
               "../",
               ".",
               "..\\",
               "\\\\\\",
               "..",
               "./",
               "//",
               "///",
               "////",
               "..."}

testString :=
 "SomeString..........      ./../.\\.\\..\\////   "

actualString, actualStrLen :=
  StrMech{}.Ptr().StripTrailingChars(
                    testString,
                    badChars)

-------------------------------------------------------------

                              1234567890
actualString is now equal to "SomeString"
actualStrLen is now equal to 10

func (*StrMech) SwapRune ¶

func (sMech *StrMech) SwapRune(
	targetStr string,
	oldRune rune,
	newRune rune,
	maxNumOfSwaps int,
	errorPrefix interface{}) (
	string,
	int,
	error)

SwapRune - Swaps, or replaces, instances of the 'oldRune' character with the 'newRune' character in the input parameter target string ('targetStr'). The number of character substitutions performed is controlled by input parameter 'maxNumOfSwaps'.

If input parameter 'targetStr' is an empty string, no error will be generated and the empty 'targetStr' will be returned.

For more information on 'runes', reference:

https://www.geeksforgeeks.org/rune-in-golang/
https://golangbyexample.com/understanding-rune-in-golang/

------------------------------------------------------------------------

Input Parameters

targetStr           string
   - This string will be searched for instances of 'oldRune'.
     When 'oldRune' is located in this string, it will be
     replaced with 'newRune'.

oldRune             rune
   - This rune or text character will be used search the parent
     string, 'targetStr'. When instances of 'oldRune' are
     located in 'targetStr', they will be replaced with
     'newRune'.

newRune             rune
   - This rune or text character will be used to replaced
     instances of 'oldRune' located in a search of 'targetStr'.

maxNumOfSwaps       int
   - This integer value constitutes the upper limit for the
     number of character substitutions performed by this method.
     If this value is less than one (+1), no limit will be
     imposed and all instances of 'oldRune' found in 'targetStr'
     will be replaced with 'newRune'.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

string
   - This string will be populated with the contents of
     'targetStr' after instances of 'oldRune' have been
      replaced by 'newRune'. Effectively, this string is the
      result of the character substitution operation.

int
   - The value of this returned integer records the number of
     character substitutions performed on 'targetStr'.

error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

 tStr := "  Hello   World  "
 ePrefix := "theCallingMethodName "

 su := StrMech{}
    resultStr,
    numOfReplacements,
    err := su.SwapRune(
             tStr,
             ' ',
             '!',
             -1,
             ePrefix)

resultSt is now equal to "!!Hello!!!World!!"
numOfReplacements is equal to '7'

func (StrMech) TrimMultipleChars ¶

func (sMech StrMech) TrimMultipleChars(
	targetStr string,
	trimChar rune,
	errorPrefix interface{}) (
	rStr string,
	err error)

TrimMultipleChars - Performs the following operations on strings:

1. Trims Right and Left ends of 'targetStr' for all instances of 'trimChar'

2. Within the interior of a string, multiple instances of 'trimChar' are reduced to a single instance.

------------------------------------------------------------------------

Input Parameters

targetStr           string
   - The parent or host string which will be searched for
     instances of the character 'trimChar'.

trimChar            rune
   - 'targetStr' will be searched for instances of this
     character. If this character is a leading or trailing
     character in 'targetStr', those instances will be deleted.
     If this character is found in the interior of 'targetStr',
     it will be reduced to one single instance of the
     character.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

rStr                string
   - This is the 'result' string. It is comprised of all the
     characters in the original 'targetStr' minus those
     'trimChar' characters deleted in the 'trim' operation.

err                 error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

ePrefix := "theCallingFunctionName() "
targetStr = "       Hello          World        "
trimChar  = ' ' (One Space Character)
sops := StrMech{}

rStr,
err := sops.TrimMultipleChars(
         targetStr,
         trimChar,
         ePrefix)

returned string (rStr) now equal to "Hello World"

func (StrMech) TrimStringEnds ¶

func (sMech StrMech) TrimStringEnds(
	targetStr string,
	trimChar rune,
	errorPrefix interface{}) (
	rStr string,
	err error)

TrimStringEnds - Removes all instances of input parameter 'trimChar' from the beginning and end of input parameter string 'targetStr'.

------------------------------------------------------------------------

Input Parameters

targetStr           string
   - The parent or host string which will be searched for
     instances of the character 'trimChar'.

trimChar            rune
   - 'targetStr' will be searched for instances of this
     character. If the character is found to be either a
     trailing character or a leading character, it will be
     deleted. If this character exists in the interior of
     'targetStr' it will be ignored and NOT deleted.

errorPrefix         interface{}
   - This object encapsulates error prefix text which is
     included in all returned error messages. Usually, it
     contains the name of the calling method or methods
     listed as a method or function chain of execution.

     If no error prefix information is needed, set this parameter
     to 'nil'.

     This empty interface must be convertible to one of the
     following types:

     1. nil - A nil value is valid and generates an empty
              collection of error prefix and error context
              information.

     2. string - A string containing error prefix information.

     3. []string A one-dimensional slice of strings containing
                 error prefix information

     4. [][2]string A two-dimensional slice of strings containing
                    error prefix and error context information.

     5. ErrPrefixDto - An instance of ErrPrefixDto. The
                       ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     6. *ErrPrefixDto - A pointer to an instance of ErrPrefixDto.
                        ErrorPrefixInfo from this object will be
                       copied to 'errPrefDto'.

     7. IBasicErrorPrefix - An interface to a method generating
                            a two-dimensional slice of strings
                            containing error prefix and error
                            context information.

     If parameter 'errorPrefix' is NOT convertible to one of
     the valid types listed above, it will be considered
     invalid and trigger the return of an error.

     Types ErrPrefixDto and IBasicErrorPrefix are included in
     the 'errpref' software package, "github.com/MikeAustin71/errpref".

------------------------------------------------------------------------

Return Values

rStr                string
   - This is the 'result' string. It is comprised of all the
     characters in the original 'targetStr' minus those
     'trimChar' characters deleted in the 'trim' operation.

err                 error
   - If the method completes successfully and no errors are
     encountered this return value is set to 'nil'. Otherwise,
     if errors are encountered this return value will contain
     an appropriate error message.

     If an error message is returned, the text value of input
     parameter 'errorPrefix' (error prefix) will be inserted or
     prefixed at the beginning of the error message.

------------------------------------------------------------------------

Example Usage

   ePrefix := "TestStrOps_TrimStringEnds_01() "
   tStr := "XXXHello WorlXdXXX"
   trimChar := 'X'

   sops := StrMech{}

   result,
   err := sops.TrimStringEnds(
            tStr,
            trimChar,
            ePrefix)

result is now equal to "Hello WorlXd"

func (*StrMech) UpperCaseFirstLetter ¶

func (sMech *StrMech) UpperCaseFirstLetter(
	str string) string

UpperCaseFirstLetter - Finds the first alphabetic character in a string (a-z A-Z) and converts it to upper case.

------------------------------------------------------------------------

Input Parameters

str                 string
   - The first character in this string will be converted to
     an Upper Case Letter.

------------------------------------------------------------------------

Return Values

string              string
   - This is copy of input parameter 'str' with the first
     character converted to upper case (a.k.a. a capital
     letter).

------------------------------------------------------------------------

Example Usage

 str := "how now brown cow."

 sops := StrMech{}

 actualStr := sops.UpperCaseFirstLetter(str)

'actualStr' is now equal to "How now brown cow."

func (*StrMech) Write ¶

func (sMech *StrMech) Write(p []byte) (n int, err error)

Write - Implements the io.Writer interface. Write writes len(p) bytes from p to the underlying data stream. In this case the underlying data stream is private member variable string, 'StrMech.stringData'.

Receives a byte array 'p' and writes the contents to a string, private structure data element 'StrMech.stringData'.

'StrMech.stringData' can be accessed through 'Getter' and 'Setter' methods, 'GetStringData()' and 'SetStringData()'.

func (TextJustify) Center ¶

func (sopsTxtJustify TextJustify) Center() TextJustify

Center - Signals that the text justification format is is set to 'Center'. Strings will be positioned in the center of the text field equidistant from the left and right margins.

Example: "   TextString   "

The 'Center' text justification has a TextJustify integer value of three (+3).

This method is part of the standard enumeration.

func (TextJustify) Left ¶

func (sopsTxtJustify TextJustify) Left() TextJustify

Left - Signals that the text justification format is set to 'Left-Justify'. Strings within text fields will be flush with the left margin.

Example: "TextString      "

The 'Left' text justification has a TextJustify integer value of one (+1).

This method is part of the standard enumeration.

func (TextJustify) None ¶

func (sopsTxtJustify TextJustify) None() TextJustify

None - Signals that 'SOpsTextJustify' value has NOT been initialized. This is an error condition.

The 'None' TextJustify integer value is zero (0).

This method is part of the standard enumeration.

func (TextJustify) Right ¶

func (sopsTxtJustify TextJustify) Right() TextJustify

Right - Signals that the text justification format is set to 'Right-Justify'. Strings within text fields will terminate at the right margin.

Example: "      TextString"

The 'Right' text justification has a TextJustify integer value of two (+2).

This method is part of the standard enumeration.

func (TextJustify) String ¶

func (sopsTxtJustify TextJustify) String() string

String - Returns a string with the name of the enumeration associated with this instance of 'TextJustify'.

This is a standard utility method and is not part of the valid enumerations for this type.

------------------------------------------------------------------------

Usage ¶

t:= TextJustify(0).Center() str := t.String()

str is now equal to 'Center'

func (TextJustify) XIsValid ¶

func (sopsTxtJustify TextJustify) XIsValid() bool

XIsValid - Returns a boolean value signaling whether the current TextJustify value is valid.

This is a standard utility method and is not part of the valid enumerations for this type.

------------------------------------------------------------------------

Usage

textJustification := TextJustify(0).Right()

isValid := textJustification.XIsValid()

func (TextJustify) XParseString ¶

func (sopsTxtJustify TextJustify) XParseString(
	valueString string,
	caseSensitive bool) (TextJustify, error)

XParseString - Receives a string and attempts to match it with the string value of a supported enumeration. If successful, a new instance of TextJustify is returned set to the value of the associated enumeration.

This is a standard utility method and is not part of the valid enumerations for this type.

------------------------------------------------------------------------

Input Parameters ¶

valueString string - A string which will be matched against the

enumeration string values. If 'valueString'
is equal to one of the enumeration names, this
method will proceed to successful completion
and return the correct enumeration value.

caseSensitive bool - If 'true' the search for enumeration names

will be case sensitive and will require an
exact match. Therefore, 'gregorian' will NOT
match the enumeration name, 'Gregorian'.

If 'false' a case insensitive search is conducted
for the enumeration name. In this case, 'gregorian'
will match match enumeration name 'Gregorian'.

------------------------------------------------------------------------

Return Values ¶

TextJustify

• Upon successful completion, this method will return a new instance of TextJustify set to the value of the enumeration matched by the string search performed on input parameter, 'valueString'.

error

• If this method completes successfully, the returned error Type is set equal to 'nil'. If an error condition is encountered, this method will return an error type which encapsulates an appropriate error message.

------------------------------------------------------------------------

Usage ¶

t, err := TextJustify(0).XParseString("Right", true)

t is now equal to TextJustify(0).Right()

func (TextJustify) XValue ¶

func (sopsTxtJustify TextJustify) XValue() TextJustify

XValue - This method returns the enumeration value of the current TextJustify instance.

This is a standard utility method and is not part of the valid enumerations for this type.

func (TextJustify) XValueInt ¶

func (sopsTxtJustify TextJustify) XValueInt() int

XValueInt - This method returns the integer value of the current TextJustify instance.

This is a standard utility method and is not part of the valid enumerations for this type.