Struct ImageData 

pub struct ImageData {
    pub media_type: String,
    pub data: Vec<u8>,
}

Helper structure for handling image data in prompts.

This struct provides a convenient way to represent images that can be included in multimodal prompts.

Fields

media_type: String

The MIME media type (e.g., “image/jpeg”, “image/png”).

data: Vec<u8>

The raw image data.

Implementations

impl ImageData

pub fn new(media_type: impl Into<String>, data: Vec<u8>) -> Self

Creates a new ImageData instance with the given media type and data.

pub fn from_file(path: impl AsRef<Path>) -> Result<Self>

Creates an ImageData instance from a file path.

The media type is inferred from the file extension.

Errors

Returns an error if the file cannot be read or if the media type cannot be determined from the file extension.

pub fn from_base64( base64_str: &str, media_type: impl Into<String>, ) -> Result<Self, DecodeError>

Creates an ImageData instance from a base64-encoded string.

Arguments

• base64_str - The base64-encoded image data
• media_type - The MIME media type of the image

Errors

Returns an error if the base64 string cannot be decoded.

pub fn to_base64(&self) -> String

Converts the image data to a base64-encoded string.

Trait Implementations

impl Clone for ImageData

fn clone(&self) -> ImageData

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ImageData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImageData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ImageData

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToPrompt for ImageData

fn to_prompt_parts(&self) -> Vec<PromptPart>

Converts the object into a vector of PromptParts using the default “full” mode.

fn to_prompt_parts_with_mode(&self, mode: &str) -> Vec<PromptPart>

Converts the object into a vector of PromptParts based on a mode.

fn to_prompt_with_mode(&self, mode: &str) -> String

Converts the object into a prompt string based on a mode.

fn to_prompt(&self) -> String

Converts the object into a prompt string using the default “full” mode.

fn prompt_schema() -> String

Returns a schema-level prompt for the type itself.

impl TryFrom<&str> for ImageData

type Error = String

The type returned in the event of a conversion error.

fn try_from(data_url: &str) -> Result<Self, Self::Error>

Performs the conversion.