zig_string

UTF-8 String Library

FORK

JakubSzark/zig-string

a big thank-you Jakub Szarkowicz real work

This library is a UTF-8 compatible string library for the Zig programming language. I made this for the sole purpose to further my experience and understanding of zig. Also it may be useful for some people who need it (including myself), with future projects. Project is also open for people to add to and improve. Please check the issues to view requested features.

The special feature: the addition of normalization to match the use in databases as well as when using screens or for lists.

Basic Usage

const zfld = @import("zfield");
// ...

// Create your String
// nbc = 0 usual string 
// nbc > 0 usual varchar(..) --> zoned 
var myString = zfld.ZFIELD.init(30);
defer myString.deinit();

// Use functions provided
try myString.concat("🔥 Hello!");
_ = myString.pop();
try myString.concat(", World 🔥");

std.debug.print("{s}",.{myString.string()});

Look at the test.zig and testmem.zig files

Things needed

• Optimizations
• Better documentation
• More Testing

How to Contribute

1. Fork
2. debug
3. Make a Test

(I'm no expert when it comes to complexity)

var arenaZfld = std.heap.ArenaAllocator.init(std.heap.page_allocator);
var allocZfld = arenaZfld.allocator();
pub fn deinitZfld() void {
    arenaZfld.deinit();
    arenaZfld = std.heap.ArenaAllocator.init(std.heap.page_allocator);
    allocZfld = arenaZfld.allocator();
}

Function	Description	Pub	Debug	Option
init	Creates String with Allocator & nbr char	x
deinit	De-allocates the String	x
allocate	Sets the internal buffer size
capacity	Returns the capacity of the String	x
getnbc	Return the numbers init char	x
Count	Returns count of characters stored	x
clear	Clears the contents of the String	x
cmpeql	Compares to (zlfd,zfld)	x
cmpeqlStr	Compares to string literal	x
cmpxx	Compares to (zlfd,zfld) l EQ LT GT	x
cmpxxStr	Compares to string literal EQ LT GT	x
setZfld	Erase append string literal of normalize	x
Normalize	Truncate for SQL Screen ex:varchar(10)
getstr	Returns the String as a slice
string	Returns the Field string	x
clone	Duplicate field	x
pop	Removes the last character	x	x
copy	Copies this string to a new one field	x
substr	Sub-string a range of characters	x	x
remove	Removes a range of characters	x	x
isEmpty	Checks if length is zero	x
find	Finds first string literal appearance	x		x
rfind	Finds last string literal appearance	x		x
findpos	Finds position occurrence of literal	x		x
concat	Appends a characters of the field	x
concatStr	Appends a characters of the literal	x
truncat	Reallocates the buffer to size	x	x
replace	Replaces all occurrences of a zstring	x
reverse	Reverses the characters in this zstring	x
lowercase	Converts to lowercase	x
uppercase	Converts to uppercase	x
capitalized	Converts to uppercase first word	x
trim	trim(zstring,whitelist)	x
trimLeft	trimLef(zstring,whitelist)	x
trim	trimRight(zstring,whitelist)	x
check	Checks if the needle zstring	x
checkStr	Checks if the needle Literal	x
charAt	Returns character at index	x	x
zfldIterator	Struct Iterator	x
next	next iterator Char(UTF8)	x
iterator	Returns a StringIterator over the String	x
isUTF8Byte	Checks if byte is part of UTF-8 character
getUTF8Size	Returns the UTF-8 character's size
getIndex	Returns the real index of a unicode			x

global allocator

    var arenaZfld = std.heap.ArenaAllocator.init(std.heap.page_allocator);
    var allocZfld = arenaZfld.allocator();

	pub fn deinitZfld() void {
	    arenaZfld.deinit();
	    arenaZfld = std.heap.ArenaAllocator.init(std.heap.page_allocator);
	    allocZfld = arenaZfld.allocator();
	}

if use zlfd.deinitZfld();

All tests comply with AS400 processing requirements