https://github.com/termermc/nim-stack-strings

Library for guaranteed zero heap allocation strings
https://github.com/termermc/nim-stack-strings

Last synced: about 1 month ago
JSON representation

Library for guaranteed zero heap allocation strings

• Host: GitHub
• URL: https://github.com/termermc/nim-stack-strings
• Owner: termermc
• License: mit
• Created: 2023-08-15T06:10:49.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-05-13T01:24:58.000Z (8 months ago)
• Last Synced: 2024-05-13T02:32:34.615Z (8 months ago)
• Language: Nim
• Homepage: https://docs.termer.net/nim/stack_strings/
• Size: 137 KB
• Stars: 21
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nim `stack_strings` Module

The `stack_strings` module provides a string implementation that works with 100% stack memory.

This module is primarily meant for programs that want to avoid any and all heap allocation, such as code for embedded targets.

If you use `--mm:arc` and `-d:useMalloc` in tandem with this module, your program will be able to do string operations without allocating any memory at runtime.

# Current Status

This library is functionally complete, but open to new features if they are relevant.

The project is actively maintained, so if you find that there are problems on a version equal to or greater than the minimum supported version, please open an issue.

# Documentation

You can view the latest documentation online [here](https://docs.termer.net/nim/stack_strings/).

To generate documentation, clone this repository and then run `nimble docgen`.

The generated HTML docs will be available in the `docs` directory in the project root.

# Nim Version Support

Only Nim `1.6.14`+ (including `2.0.0`+) is supported as there are bugs with `static int` in prior versions.