feat: promote Id to a first-class type (#2692)

Author: sxyazi

yazi-plugin/src/id.rs renamed to yazi-binding/src/id.rs

@@ -1,3 +1,3 @@
 mod macros;
 
-yazi_macro::mod_flat!(error stage url);
+yazi_macro::mod_flat!(error id stage url);

yazi-binding/src/lib.rs

@@ -1,13 +1,15 @@
 use std::{collections::HashMap, path::PathBuf};
 
+use yazi_shared::Id;
+
 #[derive(Default)]
 pub struct Cmp {
 	pub(super) caches: HashMap<PathBuf, Vec<String>>,
 	pub(super) cands:  Vec<String>,
 	pub(super) offset: usize,
 	pub cursor:        usize,
 
-	pub(super) ticket: usize,
+	pub(super) ticket: Id,
 	pub visible:       bool,
 }
 

yazi-core/src/cmp/cmp.rs

@@ -1,7 +1,7 @@
 use std::{borrow::Cow, mem, ops::ControlFlow, path::PathBuf};
 
 use yazi_macro::render;
-use yazi_shared::event::{Cmd, CmdCow, Data};
+use yazi_shared::{Id, event::{Cmd, CmdCow, Data}};
 
 use crate::cmp::Cmp;
 
@@ -11,7 +11,7 @@ struct Opt {
 	cache:      Vec<String>,
 	cache_name: PathBuf,
 	word:       Cow<'static, str>,
-	ticket:     usize,
+	ticket:     Id,
 }
 
 impl From<CmdCow> for Opt {
@@ -20,7 +20,7 @@ impl From<CmdCow> for Opt {
 			cache:      c.take_any("cache").unwrap_or_default(),
 			cache_name: c.take_any("cache-name").unwrap_or_default(),
 			word:       c.take_str("word").unwrap_or_default(),
-			ticket:     c.get("ticket").and_then(Data::as_usize).unwrap_or(0),
+			ticket:     c.get("ticket").and_then(Data::as_id).unwrap_or_default(),
 		}
 	}
 }

yazi-core/src/cmp/commands/show.rs

@@ -3,20 +3,20 @@ use std::{borrow::Cow, mem, path::{MAIN_SEPARATOR_STR, PathBuf}};
 use tokio::fs;
 use yazi_fs::{CWD, expand_path};
 use yazi_macro::{emit, render};
-use yazi_shared::event::{Cmd, CmdCow, Data};
+use yazi_shared::{Id, event::{Cmd, CmdCow, Data}};
 
 use crate::cmp::Cmp;
 
 struct Opt {
 	word:   Cow<'static, str>,
-	ticket: usize,
+	ticket: Id,
 }
 
 impl From<CmdCow> for Opt {
 	fn from(mut c: CmdCow) -> Self {
 		Self {
 			word:   c.take_first_str().unwrap_or_default(),
-			ticket: c.get("ticket").and_then(Data::as_usize).unwrap_or(0),
+			ticket: c.get("ticket").and_then(Data::as_id).unwrap_or_default(),
 		}
 	}
 }

yazi-core/src/cmp/commands/trigger.rs

@@ -43,6 +43,8 @@ impl Sendable {
 			Value::UserData(ud) => {
 				if let Ok(t) = ud.take::<yazi_binding::Url>() {
 					Data::Url(t.into())
+				} else if let Ok(t) = ud.borrow::<yazi_binding::Id>() {
+					Data::Id(**t)
 				} else if let Ok(t) = ud.take::<yazi_fs::FilesOp>() {
 					Data::Any(Box::new(t))
 				} else if let Ok(t) = ud.take::<super::body::BodyYankIter>() {
@@ -107,6 +109,7 @@ impl Sendable {
 				}
 				Value::Table(tbl)
 			}
+			Data::Id(i) => yazi_binding::Id(*i).into_lua(lua)?,
 			Data::Url(u) => yazi_binding::Url::new(u.clone()).into_lua(lua)?,
 			Data::Bytes(b) => Value::String(lua.create_string(b)?),
 			Data::Any(a) => Value::UserData(if let Some(t) = a.downcast_ref::<yazi_fs::FilesOp>() {
@@ -188,23 +191,15 @@ impl Sendable {
 			Value::Table(_) => Err("table is not supported".into_lua_err())?,
 			Value::Function(_) => Err("function is not supported".into_lua_err())?,
 			Value::Thread(_) => Err("thread is not supported".into_lua_err())?,
-			Value::UserData(ud) => {
-				if let Ok(t) = ud.take::<yazi_binding::Url>() {
-					DataKey::Url(t.into())
-				} else {
-					Err("unsupported userdata included".into_lua_err())?
-				}
-			}
+			Value::UserData(_) => Err("userdata is not supported".into_lua_err())?,
 			Value::Error(_) => Err("error is not supported".into_lua_err())?,
 			Value::Other(..) => Err("unknown data is not supported".into_lua_err())?,
 		})
 	}
 
+	#[inline]
 	fn key_to_value(lua: &Lua, key: DataKey) -> mlua::Result<Value> {
-		Ok(match key {
-			DataKey::Url(u) => yazi_binding::Url::new(u).into_lua(lua)?,
-			key => Self::key_to_value_ref(lua, &key)?,
-		})
+		Self::key_to_value_ref(lua, &key)
 	}
 
 	fn key_to_value_ref(lua: &Lua, key: &DataKey) -> mlua::Result<Value> {
@@ -214,7 +209,6 @@ impl Sendable {
 			DataKey::Integer(i) => Value::Integer(*i),
 			DataKey::Number(n) => Value::Number(n.get()),
 			DataKey::String(s) => Value::String(lua.create_string(s.as_ref())?),
-			DataKey::Url(u) => yazi_binding::Url::new(u.clone()).into_lua(lua)?,
 		})
 	}
 }

yazi-dds/src/sendable.rs

@@ -1,8 +1,7 @@
 use std::ops::Deref;
 
 use mlua::{AnyUserData, UserData, UserDataFields, UserDataMethods, Value};
-use yazi_binding::{UrlRef, cached_field};
-use yazi_plugin::Id;
+use yazi_binding::{Id, UrlRef, cached_field};
 
 use super::{Finder, Folder, Lives, Mode, Preference, Preview, PtrCell, Selected};
 

yazi-fm/src/lives/tab.rs

@@ -1,7 +1,7 @@
 use mlua::{IntoLua, Lua, Table};
-use yazi_binding::Url;
+use yazi_binding::{Id, Url};
 
-use crate::{Id, bindings::Cha, file::File};
+use crate::{bindings::Cha, file::File};
 
 pub(super) struct FilesOp(yazi_fs::FilesOp);
 

yazi-plugin/src/fs/op.rs

@@ -4,7 +4,7 @@ mod macros;
 
 yazi_macro::mod_pub!(bindings config elements external file fs isolate loader process pubsub utils);
 
-yazi_macro::mod_flat!(clipboard composer id lua runtime);
+yazi_macro::mod_flat!(clipboard composer lua runtime);
 
 pub fn init() -> anyhow::Result<()> {
 	CLIPBOARD.with(<_>::default);

yazi-plugin/src/lib.rs

@@ -1,7 +1,8 @@
 use mlua::{ExternalResult, Function, Lua, Value};
+use yazi_binding::Id;
 use yazi_dds::body::Body;
 
-use crate::{Id, runtime::RtRef};
+use crate::runtime::RtRef;
 
 pub struct Pubsub;