Struct Folder 

pub struct Folder {

    pub id: String,
    pub name: String,
    pub description: String,
    pub children: Vec<Folder>,
    pub modification_time: u64,
    pub tags: Vec<String>,
    pub extend_tags: Option<Vec<String>>,
    pub icon: Option<String>,
    pub icon_color: Option<String>,
    pub pinyin: Option<String>,
    pub password: String,
    pub password_tips: String,
    pub cover_id: Option<String>,
    pub order_by: Option<String>,
    pub sort_increase: Option<bool>,
    pub extra: Extra,
}

A node in the folder tree.

Eagle writes the keys in this order: id, name, description, children, modificationTime, tags, extendTags, icon, iconColor, pinyin, password, passwordTips, coverId, then orderBy and sortIncrease when the folder has its own sort. Optional keys are left out when unset, as JSON.stringify drops undefined.

Fields

id: String

Folder id.

name: String

Display name.

description: String

Free-form description.

children: Vec<Folder>

Child folders.

modification_time: u64

Creation time, ms since epoch. Eagle sets it when the folder is created or duplicated and leaves it alone on later edits.

tags: Vec<String>

Tags attached to the folder.

extend_tags: Option<Vec<String>>

The folder’s tags plus its ancestors’. A runtime cache Eagle’s writer strips; kept only so a file holding it round-trips.

icon: Option<String>

Icon name from FOLDER_ICONS; absent for the default folder icon.

icon_color: Option<String>

Icon colour from ICON_COLORS; absent for the default colour.

pinyin: Option<String>

Romanised name for search. Also a runtime cache Eagle’s writer strips.

password: String

Base64 of the password’s Latin-1 bytes, or empty when unset. See Folder::is_locked.

password_tips: String

Password hint (empty when unset).

cover_id: Option<String>

Id of the item shown as the folder’s cover.

order_by: Option<String>

The folder’s own sort key (see FolderOrder); absent to follow the global sort.

sort_increase: Option<bool>

Ascending when true; written alongside orderBy.

extra: Extra

Unknown keys.

Implementations

impl Folder

pub fn new( id: impl Into<String>, name: impl Into<String>, modification_time: u64, ) -> Folder

A new, empty folder in the shape Eagle writes.

pub fn walk<'a>(&'a self, f: &mut impl FnMut(&'a Folder))

Visits this folder and all descendants, depth first.

pub fn is_locked(&self) -> bool

Whether the folder has a password.

pub fn order(&self) -> Option<FolderOrder>

The folder’s own sort, if it has one Eagle knows.

Trait Implementations

impl Clone for Folder

fn clone(&self) -> Folder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Folder

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Folder

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Folder

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Folder

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Folder