https://github.com/clonkk/nim-cppstl
Nim Bindings for C++ STL stuff
https://github.com/clonkk/nim-cppstl
cpp11 hacktoberfest nim
Last synced: 20 days ago
JSON representation
Nim Bindings for C++ STL stuff
- Host: GitHub
- URL: https://github.com/clonkk/nim-cppstl
- Owner: Clonkk
- License: mit
- Created: 2019-01-13T17:00:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T11:46:41.000Z (8 months ago)
- Last Synced: 2025-04-01T16:58:33.111Z (28 days ago)
- Topics: cpp11, hacktoberfest, nim
- Language: Nim
- Homepage: https://clonkk.github.io/nim-cppstl/
- Size: 212 KB
- Stars: 52
- Watchers: 3
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Nim bindings for the C++ STL
## Introduction
This library is a Nim wrapper for C++ Standard Template Library (STL) class.
**This library is obviously only compatible with the C++ backend**
I recommand using this bindings only in two cases:
* When wrapping a C++ library (But make sure to offer a Nim idomatic API that does not expose the STL to the user if possible).
* In some performance critical code where the cost of converting Nim types to c++ types is problematic (like embeded devices).
## Installation
```
nimble install cppstl
```
Add the following lines to your `.nimble`:
```
backend = "cpp"
requires "cppstl"
```
## Limitations
#### ``cppstl`` currently wraps :
* ``std::string``
* ``std::basic_string``
* ``std::vector``
* ``std::complex``
* ``std::pair``
* Smart pointers are partially supported:
* ``std::unique_ptr``
* ``std::shared_ptr``
#### Avoid using wrapped STL objects in top-level Nim scope.
Most of the times it works on Nim 1.x but leads to both compile-time and runtime errors on 2.x.
So instantiate them in subroutines only to ensure portability between 1.x and 2.x.
I.e this usecase is not recommended:
```
when isMainModule:
var vec = initCppVector[int]()
vec.pushBack(20)
```
Use this one instead:
```
when isMainModule:
proc foo =
var vec = initCppVector[int]()
vec.pushBack(20)
foo()
```
## Contributions
All contributions are welcome!
If there is a missing function or class, that you need, don't be shy to open an issue or a PR.
### Running Tests
```
nimble test
```
or
```
testament p "tests/t*.nim"
```
## Usage
The documentation is here : https://clonkk.github.io/nim-cppstl/cppstl.html
You can find more use-case in the `tests` folder.
## License
This code is licensed under MIT license (see [LICENSE.txt](./LICENSE.txt) for details)