https://github.com/noobjsperson/c-cuid
A C Port of the CUID npm package
https://github.com/noobjsperson/c-cuid
Last synced: 5 months ago
JSON representation
A C Port of the CUID npm package
- Host: GitHub
- URL: https://github.com/noobjsperson/c-cuid
- Owner: NoobJsPerson
- Created: 2022-11-30T17:22:23.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-09T01:09:16.000Z (almost 2 years ago)
- Last Synced: 2024-06-09T02:25:40.306Z (almost 2 years ago)
- Language: C
- Size: 11.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# c-cuid
A C Port of the collision-resistant id generator [cuid](https://github.com/paralleldrive/cuid).
# Features
This library provides all the four functions as the original cuid
`char* cuid(char* buff)` writes a new null terminated cuid into given buffer (buffer size must be atleast `CUID_LENGTH` which is 26 bytes in order to fit the cuid)
`char* slug(char* buff)` writes a new null terminated slug ranging from 7 to 10 characters long into given buffer (buffer size must be atleast `SLUG_LENGTH` which is 11 bytes in order to fit the slug)
`_Bool isCuid(char* buff)` checks if given buffer is a valid cuid (returns 1 if yes, 0 if no)
`_Bool isSlug(char* buff)` checks if given buffer is a valid slug (returns 1 if yes, 0 if no)
# Usage
You could use the library as follows
```c
#include
#include "c-cuid.h"
int main(){
char cuidTest[CUID_LENGTH];
char slugTest[SLUG_LENGTH];
cuid(cuidTest);
slug(slugTest);
printf("CUID: %s\nisCuid: %s\nSLUG: %d\nisSlug:%d\n", cuidTest, slugTest, isCuid(cuidTest), isSlug(slugTest));
// output (for example):
// CUID: clb411w4100003s4f6y437nbt
// isCuid: 1
// SLUG: 632434s4
// isSlug: 1
}
```
# Testing
You could run the `test.sh` or the `test.bat` to test if the library will work on your device
If there's an error in compilation or unintended behaviour make an issue, or a pull request if you know how to fix it
# Planned features
- Adjusting and Testing for macOS (i don't have a mac, so if you have one you could do that and do a pull request I will review it as soon as possible)