Struct Item 

pub struct Item {

    pub id: String,
    pub name: String,
    pub size: u64,
    pub btime: u64,
    pub mtime: u64,
    pub ext: String,
    pub tags: Vec<String>,
    pub folders: Vec<String>,
    pub is_deleted: bool,
    pub url: String,
    pub annotation: String,
    pub modification_time: u64,
    pub remove_thumbnail: Option<bool>,
    pub no_thumbnail: Option<bool>,
    pub height: u64,
    pub width: u64,
    pub last_modified: u64,
    pub palettes: Vec<Palette>,
    pub key_order: KeyOrder,
    pub extra: Extra,
}

An item’s images/<ID>.info/metadata.json.

Fields

id: String

Item id.

name: String

Name without extension.

size: u64

Original file size in bytes.

btime: u64

Creation time, ms since epoch.

mtime: u64

File modification time, ms since epoch.

ext: String

File extension without the dot.

tags: Vec<String>

Tags.

folders: Vec<String>

Ids of the folders containing the item.

is_deleted: bool

Whether the item is in the trash.

url: String

Source URL.

annotation: String

Annotation text.

modification_time: u64

Last modification time of the record, ms since epoch.

remove_thumbnail: Option<bool>

Present only on some items.

no_thumbnail: Option<bool>

Present only on some items.

height: u64

Pixel height.

width: u64

Pixel width.

last_modified: u64

Last modification time of the content, ms since epoch.

palettes: Vec<Palette>

Dominant colours.

key_order: KeyOrder

The keys of the metadata.json this item was read from, in file order (empty for new items). Writing follows this order, and a field the file didn’t have is left out while it still holds its default, so items round-trip byte for byte. Eagle leaves out width, height and palettes for files it can’t preview, and writes keys such as noPreview and deletedTime mid-record.

extra: Extra

Unknown keys.

Implementations

impl Item

pub fn info_dir(&self, library_root: &Path) -> PathBuf

<library>/images/<id>.info.

pub fn original_path(&self, library_root: &Path) -> PathBuf

Path of the original file, <name>.<ext> inside the info dir.

pub fn thumbnail_name(&self) -> String

The file name of the item’s thumbnail, <name>_thumbnail.png.

pub fn thumbnail_path(&self, library_root: &Path) -> Option<PathBuf>

Path of <name>_thumbnail.png, if that file exists.

impl Item

pub fn manual_order_text(&self, folder: &str) -> Option<String>

The item’s raw order[folder] text, if it has a usable one.

pub fn manual_order(&self, folder: &str) -> Option<f64>

The item’s manual position value in folder (order[folder]), as a number; None when it has no entry. Larger values come first in an ascending manual sort.

pub fn manual_sort_key(&self, folder: &str) -> String

The text Eagle’s MANUAL sort compares for this item: its entry, or modificationTime when it has none.

pub fn set_manual_order(&mut self, folder: &str, value: &str)

Sets order[folder]. A new order map goes at the end of the record, a new folder key at the end of the map; existing keys keep their place.

impl Item

pub fn comments(&self) -> Vec<Comment>

The item’s comments (comments in extra), empty when it has none. Entries that are not objects are skipped.

pub fn set_comments(&mut self, comments: &[Comment])

Replaces the item’s comments. The comments key keeps its place in extra, or is added at the end, as Eagle adds it.

pub fn from_json_str(s: &str) -> Result<Item>

Parses an item’s metadata.json, recording its key order.

Trait Implementations

impl Clone for Item

fn clone(&self) -> Item

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Item

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Item

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Item

fn eq(&self, other: &Item) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Item

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Item