chore(docs): add strings guides #1922
Conversation
tmontaigu
force-pushed
the
tm/strings-guide
branch
2 times, most recently
from
7c4ebbb to
79523f9
Compare
tfhe/docs/guides/strings.md
Outdated
| This document explains the string type provided by the High-level API. | ||
|
|
||
| TFHE-RS has supports for **ASCII** strings with the type `FheAsciiString`. |
There was a problem hiding this comment.
TFHE-rs maybe even **TFHE-rs**
add a warning about missing Compact/Compressed
Talk about the fact it was a bounty that was integrated @yuxizama if you have a wording to advertise the bounty program
tmontaigu
force-pushed
the
tm/strings-guide
branch
2 times, most recently
from
3005732 to
91b6ea3
Compare
tfhe/docs/guides/strings.md
Outdated
| {% endhint %} | ||
|
|
||
| {% hint style="warning" %} | ||
| Strings are not yet compatible with CompactCiphertextList and CompressedCiphertextList |
There was a problem hiding this comment.
maybe use ` as well to surround the type names here
tfhe/docs/guides/strings.md
Outdated
| A lot of common operations are supported, to list a few of them: | ||
|
|
There was a problem hiding this comment.
if the op names are the same between HL traits and the strings module let's think of linking to docs.rs
which makes me think we should update the Cargo.toml for the docs.rs build to also use the strings feature, seems we don't build strings on docs.rs at the moment
tfhe/docs/guides/strings.md
Outdated
| let mut buffer2 = vec![]; | ||
| safe_serialize(&other_string, &mut buffer2, 1 << 30).unwrap(); | ||
| // The two strings created with padding, have the same | ||
| // memory/disk footprint, even though |
tmontaigu
force-pushed
the
tm/strings-guide
branch
from
91b6ea3 to
561e1c3
Compare
tfhe/docs/guides/strings.md
Outdated
| At encryption, strings can be encrypted with some *padding*. | ||
| The null character (b'\0') is used as the padding character, the *padding* mechanism | ||
| can be used to hide the actual length of the string. |
There was a problem hiding this comment.
Encryption with Padding
When encrypting strings, you can add paddings to hide the actual length of strings.
To add paddings, use the the null character (b'\0'). Here is an example:
There was a problem hiding this comment.
To add paddings, use the the null character (b'\0'). This sentence is not correct as its not the user that choses what is used for padding, so I changed it a bit
tmontaigu
force-pushed
the
tm/strings-guide
branch
from
561e1c3 to
7d8cb3e
Compare
No description provided.