Struct rexiv2::Metadata

pub struct Metadata { /* fields omitted */ }

An opaque structure that serves as a container for a media file's metadata.

Methods

impl Metadata

fn new_from_path<S: AsRef<OsStr>>(path: S) -> Result<Metadata>

Load the metadata from the file found at the given path.

Examples

let path = "myphoto.jpg";
let meta = rexiv2::Metadata::new_from_path(&path).unwrap();
assert_eq!(meta.get_media_type().unwrap(), rexiv2::MediaType::Jpeg);

fn new_from_buffer(data: &[u8]) -> Result<Metadata>

Load the metadata from the given data buffer.

Examples

let minipng = [137, 80, 78, 71, 13, 10, 26, 10, 0, 0, 0, 13, 73, 72, 68, 82, 0, 0, 0, 1,
               0, 0, 0, 1, 8, 0, 0, 0, 0, 58, 126, 155, 85, 0, 0, 0, 10, 73, 68, 65, 84,
               8, 215, 99, 248, 15, 0, 1, 1, 1, 0, 27, 182, 238, 86, 0, 0, 0, 0, 73, 69,
               78, 68, 174, 66, 96, 130];
let meta = rexiv2::Metadata::new_from_buffer(&minipng).unwrap();
assert_eq!(meta.get_media_type().unwrap(), rexiv2::MediaType::Png);

fn save_to_file<S: AsRef<OsStr>>(&self, path: S) -> Result<()>

Save metadata to the file found at the given path, which must already exist.

fn supports_exif(&self) -> bool

Determine whether the type of file loaded supports Exif metadata.

fn supports_iptc(&self) -> bool

Determine whether the type of file loaded supports IPTC metadata.

fn supports_xmp(&self) -> bool

Determine whether the type of file loaded supports XMP metadata.

fn get_media_type(&self) -> Result<MediaType>

Return the media type of the loaded file.

fn get_pixel_width(&self) -> i32

Get the actual un-rotated/un-oriented pixel width of the loaded image.

Note that this may be different from the values reported by some metadata tags that take into account the intended orientation of the image.

fn get_pixel_height(&self) -> i32

Get the actual un-rotated/un-oriented pixel height of the loaded image.

Note that this may be different from the values reported by some metadata tags that take into account the intended orientation of the image.

fn has_tag(&self, tag: &str) -> bool

Indicates whether the given tag is present/populated in the loaded metadata.

fn clear_tag(&self, tag: &str) -> bool

Removes the tag from the metadata if it exists. Returns whether it was there originally.

fn clear(&self)

Remove all tag values from the metadata.

fn has_exif(&self) -> bool

Indicates whether the loaded file contains any Exif metadata.

fn clear_exif(&self)

Removes all Exif metadata.

fn get_exif_tags(&self) -> Result<Vec<String>>

List all Exif tags present in the loaded metadata.

fn has_xmp(&self) -> bool

Indicates whether the loaded file contains any XMP metadata.

fn clear_xmp(&self)

Removes all XMP metadata.

fn get_xmp_tags(&self) -> Result<Vec<String>>

List all XMP tags present in the loaded metadata.

fn has_iptc(&self) -> bool

Indicates whether the loaded file contains any IPTC metadata.

fn clear_iptc(&self)

Removes all XMP metadata.

fn get_iptc_tags(&self) -> Result<Vec<String>>

List all IPTC tags present in the loaded metadata.

fn get_tag_string(&self, tag: &str) -> Result<String>

Get the value of a tag as a string.

Only safe if the tag is really of a string type.

fn set_tag_string(&self, tag: &str, value: &str) -> Result<()>

Set the value of a tag to the given string.

Only safe if the tag is really of a string type.

fn get_tag_interpreted_string(&self, tag: &str) -> Result<String>

Get the value of a tag as a string, potentially formatted for user-visible display.

Only safe if the tag is really of a string type.

fn get_tag_multiple_strings(&self, tag: &str) -> Result<Vec<String>>

Retrieve the list of string values of the given tag.

Only safe if the tag is in fact of a string type.

fn set_tag_multiple_strings(&self, tag: &str, values: &[&str]) -> Result<()>

Store the given strings as the values of a tag.

fn get_tag_numeric(&self, tag: &str) -> i32

Get the value of a tag as a number.

Only safe if the tag is really of a numeric type.

fn set_tag_numeric(&self, tag: &str, value: i32) -> Result<()>

Set the value of a tag to the given number.

Only safe if the tag is really of a numeric type.

fn get_tag_rational(&self, tag: &str) -> Option<Ratio<i32>>

Get the value of a tag as a Rational.

Only safe if the tag is in fact of a rational type.

fn set_tag_rational(&self, tag: &str, value: &Ratio<i32>) -> Result<()>

Set the value of a tag to a Rational.

Only safe if the tag is in fact of a rational type.

fn get_orientation(&self) -> Orientation

Find out the orientation the image should have, according to the metadata tag.

fn set_orientation(&self, orientation: Orientation)

Set the intended orientation for the image.

fn get_exposure_time(&self) -> Option<Ratio<i32>>

Returns the camera exposure time of the photograph.

fn get_fnumber(&self) -> Option<f64>

Returns the f-number used by the camera taking the photograph.

fn get_focal_length(&self) -> Option<f64>

Returns the focal length used by the camera taking the photograph.

fn get_iso_speed(&self) -> Option<i32>

Returns the ISO speed used by the camera taking the photograph.

fn get_gps_info(&self) -> Option<GpsInfo>

Retrieve the stored GPS information from the loaded file.

fn set_gps_info(&self, gps: &GpsInfo) -> Result<()>

Save the specified GPS values to the metadata.

fn delete_gps_info(&self)

Remove all saved GPS information from the metadata.

Trait Implementations

impl Debug for Metadata

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for Metadata

fn eq(&self, __arg_0: &Metadata) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Metadata) -> bool

This method tests for !=.

impl Drop for Metadata

fn drop(&mut self)

A method called when the value goes out of scope.