Si - Simple Image Manipulation in Rust

The Si crate (pronounced "ess-eye") is a lightweight and easy-to-use Rust library to create Social Share Images (the website previews you see, for example).

See the examples in examples to get started.

Installation

To use the Si crate in your Rust project, add it as a dependency in your Cargo.toml file:

[dependencies]
si-img = "0.4.0"

[!WARNING] Due to some reasons, there has been no updates to this project for about a year now. But I've finally returned to it, and I plan on making various changes pretty soon. So, be prepared for the future versions to lose backwards-compatibility real soon!

[!NOTE] The v1, which I already have planned, is where this library will finally stabilize, and all backwards-incompatible changes will seize!

Getting Started

To start using the Si crate, import the necessary modules:

use si_img::{SiImage, SiFont, TextOptions};

Creating a Font

You can create a custom font using the SiFont::from_network constructor. You need to provide a font URL. Here's an example:

let font = SiFont::from_network("FONT_URL"); // Synchronously (blocking, use SiFont::from_network_async for async fetching)

Creating an Image

Next, create an image using the SiImage::from_network constructor. You'll need to provide an image URL:

let img = SiImage::from_network("Image_URL"); // Synchronously (blocking, use SiImage::from_network_async for async fetching)

Creating Text Options

As of v0.4, Text Options are required.

let text_options = TextOptions::default();

Adding Text to the Image

Now, you can add text to the image using the text method. Specify the text, scale, x and y coordinates, an optional color (or use None for the default color), and the font you created earlier:

img.text("Hello Cool User", 48.00, 32.0, 20.0, Some("#00ffff".to_string()), &font, &text_options);

Getting Image Bytes

Finally, you can retrieve the (decoded) image as bytes using the to_bytes method:

let bytes = img.to_bytes();

Example

Here's a complete example that puts it all together:

use si_img::{SiImage, SiFont};

fn main() {
    // Create a font
    let font = SiFont::from_network("FONT_URL");

    // Create an image
    let img = SiImage::from_network("Image_URL");

    // Add text to the image
    img.text("Hello Cool User", 48.00, 32.0, 20.0, Some("#00ffff".to_string()), &font);

    // Get image bytes
    let bytes = img.to_bytes();

    // Do something with the image bytes (e.g., save to a file or send over a network)
}

That's it! You now have the basics to start using the Si crate for simple image manipulation in your Rust projects. Feel free to explore more features and customization options provided by the crate as you build your image processing applications.

Note: This Crate serves as the base for the WebAssembly-based Si.js library (for Node.js and Deno).