Skip to content

Commit 66a1145

Browse files
committed
Add README
1 parent a58c5f4 commit 66a1145

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# cstring Module
2+
3+
Alternate string representation to the built-in `str` type.
4+
5+
* Uses C-string representation internally.
6+
* Memory is allocated in one continuous buffer to reduce pointer-hopping.
7+
* UTF-8 encoding.
8+
* `len` returns size in _bytes_ (not including terminating zero-byte).
9+
* Random access (to _bytes_, *not* Unicode code points) is supported with indices and slices.
10+
11+
## TODO
12+
13+
* Write docs (see `str` type docs)
14+
* Write docstrings
15+
* Fill out setup.py
16+
* Implement repr
17+
* Implement iter (iterate over Unicode code points, "runes")
18+
* Implement str methods
19+
* Implement buffer interface?
20+
* Decide subclassing protocol

0 commit comments

Comments
 (0)