README
¶
StringFormatter
A set of tools that helps to build strings from templates and process text that faster than fmt!!!.
Features
- Text formatting with template using traditional for C#, Python programmers style - {0}, {name} that faster then fmt does:
benchmark could be runned:
- to see Format result -
go test -bench=Format -benchmem -cpu 1 - to see fmt result -
go test -bench=Fmt -benchmem -cpu 1
- Soon will be added new useful features
Description
This is a GO module for template text formatting in syntax like in C# or/and Python using:
- {n} , n here is a number to notes order of argument list to use
- {name} to notes arguments by name i.e. {name}, {last_name}, {address} and so on ...
Examples
Format by arg order
i.e. you have following template: Hello {0}, we are greeting you here: {1}!
if you call Format with args "manager" and "salesApp" :
formattedStr := Format("Hello {0}, we are greeting you here: {1}!", "manager", "salesApp")
you get string "Hello manager, we are greeting you here: salesApp!"
Format by arg key
i.e. you have following template: "Hello {user} what are you doing here {app} ?"
if you call FormatComplex with args "vpupkin" and "mn_console" FormatComplex("Hello {user} what are you doing here {app} ?", map[string]interface{}{"user":"vpupkin", "app":"mn_console"})
you get string "Hello vpupkin what are you doing here mn_console ?"
another example is:
strFormatResult = FormatComplex("Current app settings are: ipAddr: {ipaddr}, port: {port}, use ssl: {ssl}.",
map[string]interface{}{"ipaddr":"127.0.0.1", "port":5432, "ssl":false})
a result will be: "Current app settings are: ipAddr: 127.0.0.1, port: 5432, use ssl: false."
Contributors
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Format ¶
Format
Func that makes string formatting from template * It differs from above function only by generic interface that allow to use only primitive data types: * - integers (int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uin64) * - floats (float32, float64) * - boolean * - string * - complex * - objects * This function defines format automatically * Parameters * - template - string that contains template * - args - values that are using for formatting with template * Returns formatted string
func FormatComplex ¶
FormatComplex
Function that format text using more complex templates contains string literals i.e "Hello {username} here is our application {appname}
* Parameters
* - template - string that contains template
* - args - values (dictionary: string key - any value) that are using for formatting with template
* Returns formatted string
Types ¶
This section is empty.
Source Files