9 unstable releases

new 0.5.2 Oct 7, 2024
0.5.1 Sep 28, 2024
0.5.0 Jul 23, 2024
0.4.0 Nov 27, 2023
0.1.0 Jun 3, 2023

#307 in Web programming

Download history 25/week @ 2024-06-16 22/week @ 2024-06-23 38/week @ 2024-06-30 8/week @ 2024-07-07 19/week @ 2024-07-14 128/week @ 2024-07-21 106/week @ 2024-07-28 20/week @ 2024-08-04 6/week @ 2024-08-18 11/week @ 2024-08-25 8/week @ 2024-09-01 9/week @ 2024-09-08 251/week @ 2024-09-22 67/week @ 2024-09-29

328 downloads per month

MIT/Apache

115KB
3K SLoC

cloudinary

codecov crates.io Released API docs

At the moment, there is only half-backed upload and transformation functionality, but if you need more, please let me know.

Upload an image

Upload can be done from different sources:

  • local file
  • remote file
  • data url rfc2397

Local file

use cloudinary::upload::{UploadOptions, Source, Upload};
let options = UploadOptions::new().set_public_id("file.jpg".to_string());
let upload = Upload::new("api_key".to_string(), "cloud_name".to_string(), "api_secret".to_string() );
let result = upload.image(Source::Path("./image.jpg".into()), &options);

Remote file

use cloudinary::upload::{UploadOptions, Source, Upload};
let image_url = "https://upload.wikimedia.org/wikipedia/commons/c/ca/1x1.png";
let options = UploadOptions::new().set_public_id("1x1.png".to_string());
let upload = Upload::new("api_key".to_string(), "cloud_name".to_string(), "api_secret".to_string() );
let result = upload.image(Source::Url(image_url.try_into().unwrap()), &options);

Data url

use cloudinary::upload::{UploadOptions, Source, Upload};
let data_url = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==";
let options = UploadOptions::new().set_public_id("1x1.png".to_string());
let upload = Upload::new("api_key".to_string(), "cloud_name".to_string(), "api_secret".to_string() );
let result = upload.image(Source::DataUrl(data_url.into()), &options);

Destroy an asset by publicID

use cloudinary::upload::Upload;
let upload = Upload::new("api_key".to_string(), "cloud_name".to_string(), "api_secret".to_string() );
let result = upload.destroy("publicID");

Transform an image

Currently supported transformations:

  • Resize
  • Crop
  • Pad

Resizing an image:

use cloudinary::transformation::{
    Transformations::Resize, resize_mode::ResizeMode::ScaleByWidth, Image, aspect_ratio::AspectRatio
};

let image = Image::new("test".into(), "path/name.png".into())
    .add_transformation(Resize(ScaleByWidth{ width:100, ar: None, liquid:None}));
assert_eq!(
    image.to_string(),
    "https://res.cloudinary.com/test/image/upload/c_scale,w_100/path/name.png"
);

Cropping an image:

use cloudinary::transformation::{
   Transformations::Crop, crop_mode::CropMode::FillByWidth, Image, aspect_ratio::AspectRatio
};

let image = Image::new("test".into(), "path/name.png".into())
    .add_transformation(Crop(FillByWidth{ width:100, ar: None, gravity: None}));

assert_eq!(
    image.to_string(),
    "https://res.cloudinary.com/test/image/upload/c_fill,w_100/path/name.png"
);

Padding an image:

use cloudinary::transformation::{
  Transformations::Pad, pad_mode::PadMode::PadByWidth, Image, aspect_ratio::AspectRatio
};

let image = Image::new("test".into(), "path/name.png".into())
    .add_transformation(Pad(PadByWidth{ width:100, ar: None, background: None, gravity: None}));
assert_eq!(
   image.to_string(),
   "https://res.cloudinary.com/test/image/upload/c_pad,w_100/path/name.png"
);

Get Image from URL

Unofficial api. This is not supported by Cloudinary, and can break at any time. Officially you should use public_id that you get from upload.

Support

use cloudinary::transformation::Image;
use url::Url;
let image = Image::try_from(
    Url::parse("https://res.cloudinary.com/test/image/upload/path/name.png").unwrap()
).unwrap();
assert_eq!(image.to_string(), "https://res.cloudinary.com/test/image/upload/path/name.png");

Get a list of all assets with a given tag

use cloudinary::tags::get_tags;
let tags = get_tags("cloud_name".into(), "tag_name".into()).await;

Minimum supported Rust version

The minimum supported Rust version for this crate is 1.65

License: MIT OR Apache-2.0

Dependencies

~8–20MB
~279K SLoC