Skip to content

docs: add a note about endianness #438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add a note about endianness #438

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ fallback implementation, but this is significantly slower.
For best performance, we highly suggest using [snmalloc](https://github.com/microsoft/snmalloc), [mimalloc](https://crates.io/crates/mimalloc) or [jemalloc](https://crates.io/crates/jemalloc)
instead of the system default allocator.

### Endianness
This crate only works on little endian platforms. It DOES NOT WORK on big endian platforms (e.g. s390x, big-endian ARM, MIPS, etc.)
See https://doc.rust-lang.org/nightly/rustc/platform-support.html for a complete list.

## Safety

`simd-json` uses **a lot** of unsafe code.
Expand Down