Struct Image 

pub struct Image {
    pub raw: *mut NvdImage,
    /* private fields */
}

A simple image loaded from NvDialog. This is the equivalent to NvdImage, although the implementation makes a few extra safety checks from the Rust side.

Fields

raw: *mut NvdImage

Implementations

impl Image

pub fn from_filename(filename: PathBuf) -> Result<Self, ImageError>

Creates an Image from a specified filename.

This function attempts to load an image from the given file path using NvDialog’s image loading facilities. It performs a few checks to ensure robustness and safety from the Rust side.

Arguments

• filename - A PathBuf specifying the file path of the image to be loaded.

Returns

• Result<Self, ImageError> - Returns an Ok variant containing the Image if successful, or an ImageError if an error occurs during the process.

Errors

• ImageError::PathNotFound - Returned if the file path does not exist.
• ImageError::UnknownError - Returned if the image cannot be created from the data.

Safety

This function makes use of unsafe blocks to interface with the C functions from NvDialog. It is assumed that nvd_image_from_filename and nvd_create_image are safe to call with the provided arguments.

Examples found in repository

examples/about-dialog.rs (line 16)

fn main() {
    nvdialog_rs::init().expect("failed to initialize libnvdialog");
    let extensions = ["png", "jpeg", "jpg", "ico", "webp"];
    let filedlg = FileDialog::new(
        "Choose the icon for the dialog",
        FileDialogType::OpenFile,
        Some(extensions),
    );
    let filename = filedlg.retrieve_filename().unwrap_or_else(|| {
        eprintln!("No filename given!");
        abort()
    });
    let img = Image::from_filename(filename).unwrap_or_else(|e| {
        eprintln!("Failed to read image! {}", e.to_string());
        abort();
    });

    let dialog = AboutDialog::new()
        .name("NvDialog Example")
        .description(
            "An example of using nvdialog-rs and NvdAboutDialog, with a custom user-picked icon",
        )
        .icon(img)
        .build();

    dialog.show();
}

pub unsafe fn from_data( data: &[u8], width: u32, height: u32, ) -> Result<Self, ImageError>

Creates an Image from the raw data of an image file.

This function creates an Image from raw data that is assumed to be in a format that NvDialog can read. The data is sent to the NvDialog library without any checking on the Rust side, so it is left up to the user to ensure that the data is valid.

Safety

This function is marked unsafe because the data passed to it is not checked in any way. If the data is not valid, it may cause undefined behavior when passed to the C library.

Arguments

• data - The raw image data. This is assumed to be the contents of an image file and should be in a format that NvDialog can read.
• width - The width of the image in pixels.
• height - The height of the image in pixels.

Returns

• Result<Self, ImageError> - Returns an Ok variant containing the Image if successful, or an ImageError if an error occurs.

Errors

• ImageError::InvalidFormat - Returned if the data is not in a valid format for NvDialog.
• ImageError::UnknownError - Returned if the image cannot be created from the data for some other reason.

Trait Implementations

impl Drop for Image

fn drop(&mut self)

Executes the destructor for this type.