Document the image feature flag, and converting to a base64 png. #24
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dessalines
commented
Oct 20, 2025
dessalines
commented
- Fixes How do convert the decoded result to a base64 encoded image? #23
dessalines
commented
Oct 20, 2025
Author
There was a problem hiding this comment.
Ran prettier on this file also.
rubdos
requested changes
Oct 21, 2025
Member
rubdos
left a comment
rubdos
left a comment
There was a problem hiding this comment.
I also noticed now that decode_image is not shown in docs.
README.md
Outdated
Comment on lines
59
to
70
| If you'd like to convert this image to a base64 `png`, you can add the `base64` and `image` crates, then do: | ||
|
|
||
| ```rust | ||
| use base64::{engine::general_purpose, Engine as _}; | ||
| use std::io::Cursor; | ||
|
|
||
| let mut bytes: Vec<u8> = Vec::new(); | ||
| image_buffer.write_to(&mut Cursor::new(&mut bytes), image::ImageOutputFormat::Png).unwrap(); | ||
|
|
||
| let b64_png = general_purpose::STANDARD.encode(bytes); | ||
| ``` | ||
|
|
Member
There was a problem hiding this comment.
I wouldn't include this. The whole purpose of blurhash is to have a succinct representation of an image, and this method does the exact opposite: it decodes our succinct representation into an image, then recompresses as a png, and then blows up the file through base64.
src/lib.rs
Outdated
Comment on lines
32
to
42
| //! If you'd like to convert this image to a base64 `png`, you can add the `base64` and `image` crates, then do: | ||
| //! | ||
| //! ```no_run | ||
| //! use base64::{engine::general_purpose, Engine as _}; | ||
| //! use std::io::Cursor; | ||
| //! | ||
| //! let mut bytes: Vec<u8> = Vec::new(); | ||
| //! image_buffer.write_to(&mut Cursor::new(&mut bytes), image::ImageOutputFormat::Png).unwrap(); | ||
| //! | ||
| //! let b64_png = general_purpose::STANDARD.encode(bytes); | ||
| //! ``` |
Member
There was a problem hiding this comment.
Same here. This is not an approach I want to recommend to users of this crate.
Co-authored-by: Ruben De Smet <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.