aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJohannes Stoelp <johannes.stoelp@gmail.com>2021-09-14 22:47:33 +0200
committerJohannes Stoelp <johannes.stoelp@gmail.com>2021-09-14 22:47:33 +0200
commitb5e90b2495c0c66670c94f9ae6a50434490fa9af (patch)
treebd3d4496cd633427202c1dbd1e407c202a39ce03
parent743f301eef632a41bd870529a9e838ce4974f9eb (diff)
downloadllvm-kaleidoscope-rs-b5e90b2495c0c66670c94f9ae6a50434490fa9af.tar.gz
llvm-kaleidoscope-rs-b5e90b2495c0c66670c94f9ae6a50434490fa9af.zip
lib: updated comment on SmallCStr
-rw-r--r--src/lib.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 64721a7..1e1112e 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -9,6 +9,8 @@ pub mod parser;
pub const SMALL_STR_SIZE: usize = 16;
/// Small C string on the stack with fixed size [`SMALL_STR_SIZE`].
+///
+/// This is specially crafted to interact with the LLVM C API and get rid of some heap allocations.
#[derive(Debug, PartialEq)]
pub struct SmallCStr([u8; SMALL_STR_SIZE]);