Skip to main content

​
Overview

The ImageUploadResponse struct represents the response returned after successfully uploading an image.

​
Definition

pub struct ImageUploadResponse {
    pub url: String,
    pub public_id: String,
    pub size: u64,
    pub format: String,
    pub width: Option<u32>,
    pub height: Option<u32>,
}

​
Fields

​
url
String
required
The public URL where the uploaded image can be accessed.
​
public_id
String
required
A unique identifier for the uploaded image, used for reference and management.
​
size
u64
required
The file size of the uploaded image in bytes.
​
format
String
required
The image format (e.g., “png”, “jpg”, “webp”).
​
width
Option<u32>
The width of the image in pixels, if available.
​
height
Option<u32>
The height of the image in pixels, if available.

​
Usage Example

use wacht::api::settings::upload_image;
use std::fs;

// Read image file
let image_data = fs::read("logo.png")?;

// Upload as logo
let response = upload_image("logo", image_data, "logo.png".to_string()).await?;

println!("Image uploaded successfully!");
println!("URL: {}", response.url);
println!("Public ID: {}", response.public_id);
println!("Size: {} KB", response.size / 1024);
println!("Format: {}", response.format);

if let (Some(width), Some(height)) = (response.width, response.height) {
    println!("Dimensions: {}x{}", width, height);
}

// Upload avatar image
let avatar_data = fs::read("avatar.jpg")?;
let avatar_response = upload_image("avatar", avatar_data, "avatar.jpg".to_string()).await?;

// Update display settings with the new logo URL
use wacht::api::settings::{fetch_deployment_settings, update_display_settings};

let mut settings = fetch_deployment_settings().await?;
settings.display_settings.logo_url = Some(response.url);
update_display_settings(settings.display_settings).await?;

​
Image Types

The image_type parameter in the upload function accepts:
  • "logo" - For deployment logo images
  • "avatar" - For user avatar images
  • "favicon" - For favicon images
  • "banner" - For banner images

​
See Also