mini freamwork to render images in the terminals/ttys.
let cfg = Config::new(vec![' ', '.', ',', '-', '~', '!', '*', '%', '$', '@', '#'].into());
let image = image::open("mylove.jpg").unwrap();
let (w, h) = image.dimensions();
let mut out = BufWriter::with_capacity(cfg.calc_buf_size(w, h), io::stdout().lock());
convert_image_to_ascii(&cfg, &image, &mut out).expect("IO error");
Enable the foreground colors
let cfg = Config::new(vec![' ', '.', ',', '-', '~', '!', '*', '%'].into()).with_flags(COLORS);
// ...
Reverse them with the background color
let cfg = Config::new(Sympols::empty()).with_background((232, 209, 204)).with_flags(COLORS | REVERSE);
// ...
If you wanna build a rebresentesion in memory so you can modify it or use it multiple times, then you may found that implement [FragmentWriter]
for such a structher is useful.
struct TerminalFrame {
fragments: Vec<(char, ANSIColor)>,
cfg: Config,
}
impl FragmentWriter for TerminalFrame {
fn background(&mut self, _: &ANSIColor) -> Result<bool, Box<dyn std::error::Error>> {
// Nah, I don't care, I have my configs :p
// but pretent like if you care so it will skip the swap operation.
Ok(true)
}
fn write_fragment(&mut self, info: FragmentInfo) -> Result<(), Box<dyn std::error::Error>> {
self.fragments.push((info.sym, info.fg));
Ok(())
}
fn write_colored_fragment(
&mut self,
info: FragmentInfo,
_: Option<&ANSIColor>,
_: Option<&ANSIColor>,
) -> Result<(), Box<dyn std::error::Error>> {
self.write_fragment(info)
}
fn write_bytes(&mut self, _bytes: &[u8]) -> Result<(), Box<dyn std::error::Error>> {
// Just ignore them
Ok(())
}
}
// So you can use it as a buffer
let cfg = Config::new(vec!['I', 'L', 'O', 'V', 'E', 'U'].into()).with_flags(COLORS);
let image = image::open("mylove.jpg").unwrap();
let (w, h) = image.dimensions();
let mut frame = TerminalFrame {
fragments: Vec::with_capacity(w as usize * h as usize),
cfg: cfg.clone(),
};
aarty::convert_image_to_ascii(&cfg, &image, &mut frame).expect("Write error");
// Do whatever you want with this object...
But be aware by doing this, you'll have to implement the rendaring mechanism when its its the time to print the image (a.k.a. rendering it).
For such this case, we have [TextImage], which basically dose the same thing as the code above but in more ergnomic way, And it does implement the rendering mechanism, so you can just print it, and it will render the image properly.
You can enable this type with text_image feature, which is enabled by default.
The text_image feature also include the [ToTextImage] trait, which provide an ergonomic way to construct an [TextImage] object.
use aarty::ToTextImage;
let cfg = Config::new_with_background(Sympols::empty(), (232, 209, 204).into()).with_flags(COLORS | REVERSE);
let image = image::open("mylove.jpg").unwrap().to_text(cfg);
println!("{image}");
You have to enable the
imagefeature for this to work.
We offer a simple binary that's implement the most of this crate features. You can build it with the build command or if u use cargo then you can install it via cargo install aarty.
[!Note] for more information about the binary and how to use it, you can run
aarty --helpor see this document.
I'm happy to accept any contributions, just consider reading the CONTRIBUTING.md guide first.
the main keywords are: signed commits, conventional commits, no emojis, linear history, the PR shouldn't have more than tree commits most of the time
This project is licensed under MIT license.
Generated with cargo-depgraph
[0.6.1] - 2024-01-28
Full Changelog: https://github.com/0x61nas/aarty/compare/0.6...0.6.1
Full Changelog: https://github.com/0x61nas/aarty/compare/0.5...0.6
is_empty method to TextImageserde::Serialize and serde::Deserializeimage crate optional and add a uniform api_no_ref feature and fix impl_serdeclap crate and use our custom parserlog and pretty_env_logger and colored crates from our depsimpl_serde feature to serdebc to backgroundimage crate patch versionCargo.lock entryCargo.lock filetypos configdeny configFull Changelog: https://github.com/0x61nas/aarty/compare/0.4.9...0.5
FAQs
Unknown package
We found that aarty demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Malicious Nx npm versions stole secrets and wallet info using AI CLI tools; Socket’s AI scanner detected the supply chain attack and flagged the malware.
Security News
CISA’s 2025 draft SBOM guidance adds new fields like hashes, licenses, and tool metadata to make software inventories more actionable.
Security News
A clarification on our recent research investigating 60 malicious Ruby gems.