Struct ShellItem 

#[non_exhaustive]
pub struct ShellItem {
    pub class: u8,
    pub kind: ShellItemKind,
    pub name: Option<String>,
    pub long_name: Option<String>,
    pub file_size: Option<u32>,
    pub modified: Option<i64>,
    pub created: Option<i64>,
    pub accessed: Option<i64>,
    pub mft_entry: Option<u64>,
    pub mft_sequence: Option<u16>,
    pub guid: Option<String>,
    pub raw: Vec<u8>,
}

One decoded shell item — a single component of an ITEMIDLIST.

Fields are populated on a best-effort, per-class basis; a field that does not apply to the item’s class, or that was absent/truncated in the bytes, is None. The raw item bytes (including the cb size prefix) are always retained in ShellItem::raw so a consumer can re-inspect or surface the class byte for an ShellItemKind::Unknown item.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

class: u8

The raw class-type indicator byte (offset 2 of the item).

kind: ShellItemKind

The decoded class family.

name: Option<String>

The item’s short / display name (DOS short name for a file entry, drive string for a volume, GUID display label for a root item).

long_name: Option<String>

The long (Unicode) name from the 0xbeef0004 extension block, when the item is a file entry and the block is present.

file_size: Option<u32>

The file size (u32) for a file-entry item.

modified: Option<i64>

Last-modified timestamp (Unix epoch seconds, UTC) — the file entry’s FAT date/time.

created: Option<i64>

Creation timestamp (Unix epoch seconds, UTC) from the 0xbeef0004 extension block.

accessed: Option<i64>

Last-access timestamp (Unix epoch seconds, UTC) from the 0xbeef0004 extension block.

mft_entry: Option<u64>

NTFS MFT entry index (48-bit) from the 0xbeef0004 file reference, when the extension version is high enough to carry it.

mft_sequence: Option<u16>

NTFS MFT sequence number (16-bit) from the 0xbeef0004 file reference.

guid: Option<String>

Shell-folder GUID for a root item, in canonical upper-case form.

raw: Vec<u8>

The full raw bytes of this item, including the 2-byte cb size prefix.

Implementations

impl ShellItem

pub fn display_name(&self) -> Option<&str>

The best available display name for this item, preferring the most specific: long name → short/display name → GUID. Returns None only when the item carries no usable label at all.

Trait Implementations

impl Clone for ShellItem

fn clone(&self) -> ShellItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShellItem

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

Formats the value using the given formatter.

impl Eq for ShellItem

impl PartialEq for ShellItem

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ShellItem