Last rename, I swear

Cargo.toml

@@ -1,12 +1,12 @@
 [package]
-name = "mlua-luau-runtime"
+name = "mlua-luau-scheduler"
 version = "0.0.0"
 edition = "2021"
 license = "MPL-2.0"
-repository = "https://github.com/lune-org/mlua-luau-runtime"
-description = "Luau-based async runtime, using mlua and async-executor"
+repository = "https://github.com/lune-org/mlua-luau-scheduler"
+description = "Luau-based async scheduler, using mlua and async-executor"
 readme = "README.md"
-keywords = ["async", "luau", "runtime"]
+keywords = ["async", "luau", "scheduler"]
 categories = ["async"]
 
 [dependencies]

README.md

@@ -1,22 +1,22 @@
 <!-- markdownlint-disable MD033 -->
 <!-- markdownlint-disable MD041 -->
 
-<h1 align="center">mlua-luau-runtime</h1>
+<h1 align="center">mlua-luau-scheduler</h1>
 
 <div align="center">
 	<div>
-		<a href="https://github.com/lune-org/mlua-luau-runtime/actions">
-			<img src="https://shields.io/endpoint?url=https://badges.readysetplay.io/workflow/lune-org/mlua-luau-runtime/ci.yaml" alt="CI status" />
+		<a href="https://github.com/lune-org/mlua-luau-scheduler/actions">
+			<img src="https://shields.io/endpoint?url=https://badges.readysetplay.io/workflow/lune-org/mlua-luau-scheduler/ci.yaml" alt="CI status" />
 		</a>
-		<a href="https://github.com/lune-org/mlua-luau-runtime/blob/main/LICENSE.txt">
-			<img src="https://img.shields.io/github/license/lune-org/mlua-luau-runtime.svg?label=License&color=informational" alt="Crate license" />
+		<a href="https://github.com/lune-org/mlua-luau-scheduler/blob/main/LICENSE.txt">
+			<img src="https://img.shields.io/github/license/lune-org/mlua-luau-scheduler.svg?label=License&color=informational" alt="Crate license" />
 		</a>
 	</div>
 </div>
 
 <br/>
 
-An async runtime for Luau, using [`mlua`][mlua] and built on top of [`async-executor`][async-executor].
+An async scheduler for Luau, using [`mlua`][mlua] and built on top of [`async-executor`][async-executor].
 
 This crate is runtime-agnostic and is compatible with any async runtime, including [Tokio][tokio], [smol][smol], [async-std][async-std], and others. </br>
 However, since many dependencies are shared with [smol][smol], depending on it over other runtimes may be preferred.
@@ -39,7 +39,7 @@ use async_io::{block_on, Timer};
 use async_fs::read_to_string;
 
 use mlua::prelude::*;
-use mlua_luau_runtime::*;
+use mlua_luau_scheduler::*;
 ```
 
 ### 2. Set up Lua environment
@@ -73,16 +73,16 @@ lua.globals().set(
 )?;
 ```
 
-### 3. Set up runtime, run threads
+### 3. Set up scheduler, run threads
 
 ```rs
-let rt = Runtime::new(&lua)?;
+let rt = Scheduler::new(&lua)?;
 
 // We can create multiple lua threads ...
 let sleepThread = lua.load("sleep(0.1)");
 let fileThread = lua.load("readFile(\"Cargo.toml\")");
 
-// ... spawn them both onto the runtime ...
+// ... spawn them both onto the scheduler ...
 rt.push_thread_front(sleepThread, ());
 rt.push_thread_front(fileThread, ());
 

examples/basic_sleep.rs

@@ -5,7 +5,7 @@ use std::time::{Duration, Instant};
 use async_io::{block_on, Timer};
 
 use mlua::prelude::*;
-use mlua_luau_runtime::Runtime;
+use mlua_luau_scheduler::Scheduler;
 
 const MAIN_SCRIPT: &str = include_str!("./lua/basic_sleep.luau");
 
@@ -27,8 +27,8 @@ pub fn main() -> LuaResult<()> {
         })?,
     )?;
 
-    // Load the main script into a runtime
-    let rt = Runtime::new(&lua);
+    // Load the main script into a scheduler
+    let rt = Scheduler::new(&lua);
     let main = lua.load(MAIN_SCRIPT);
     rt.push_thread_front(main, ())?;
 

examples/basic_spawn.rs

@@ -6,7 +6,7 @@ use async_fs::read_to_string;
 use async_io::block_on;
 
 use mlua::prelude::*;
-use mlua_luau_runtime::{LuaSpawnExt, Runtime};
+use mlua_luau_scheduler::{LuaSpawnExt, Scheduler};
 
 const MAIN_SCRIPT: &str = include_str!("./lua/basic_spawn.luau");
 
@@ -46,8 +46,8 @@ pub fn main() -> LuaResult<()> {
         })?,
     )?;
 
-    // Load the main script into a runtime
-    let rt = Runtime::new(&lua);
+    // Load the main script into a scheduler
+    let rt = Scheduler::new(&lua);
     let main = lua.load(MAIN_SCRIPT);
     rt.push_thread_front(main, ())?;
 

examples/callbacks.rs

@@ -2,7 +2,7 @@
 #![allow(clippy::missing_panics_doc)]
 
 use mlua::prelude::*;
-use mlua_luau_runtime::Runtime;
+use mlua_luau_scheduler::Scheduler;
 
 use async_io::block_on;
 
@@ -18,8 +18,8 @@ pub fn main() -> LuaResult<()> {
     // Set up persistent Lua environment
     let lua = Lua::new();
 
-    // Create a new runtime with custom callbacks
-    let rt = Runtime::new(&lua);
+    // Create a new scheduler with custom callbacks
+    let rt = Scheduler::new(&lua);
     rt.set_error_callback(|e| {
         println!(
             "Captured error from Lua!\n{}\n{e}\n{}",
@@ -28,7 +28,7 @@ pub fn main() -> LuaResult<()> {
         );
     });
 
-    // Load the main script into the runtime, and keep track of the thread we spawn
+    // Load the main script into the scheduler, and keep track of the thread we spawn
     let main = lua.load(MAIN_SCRIPT);
     let id = rt.push_thread_front(main, ())?;
 

examples/exit_code.rs

@@ -4,7 +4,7 @@
 use async_io::block_on;
 
 use mlua::prelude::*;
-use mlua_luau_runtime::{Functions, Runtime};
+use mlua_luau_scheduler::{Functions, Scheduler};
 
 const MAIN_SCRIPT: &str = include_str!("./lua/exit_code.luau");
 
@@ -17,12 +17,12 @@ pub fn main() -> LuaResult<()> {
 
     // Set up persistent Lua environment
     let lua = Lua::new();
-    let rt = Runtime::new(&lua);
+    let rt = Scheduler::new(&lua);
     let fns = Functions::new(&lua)?;
 
     lua.globals().set("exit", fns.exit)?;
 
-    // Load the main script into the runtime
+    // Load the main script into the scheduler
     let main = lua.load(MAIN_SCRIPT);
     rt.push_thread_front(main, ())?;
 

examples/lots_of_threads.rs

@@ -5,7 +5,7 @@ use std::time::Duration;
 use async_io::{block_on, Timer};
 
 use mlua::prelude::*;
-use mlua_luau_runtime::{Functions, Runtime};
+use mlua_luau_scheduler::{Functions, Scheduler};
 
 const MAIN_SCRIPT: &str = include_str!("./lua/lots_of_threads.luau");
 
@@ -20,7 +20,7 @@ pub fn main() -> LuaResult<()> {
 
     // Set up persistent Lua environment
     let lua = Lua::new();
-    let rt = Runtime::new(&lua);
+    let rt = Scheduler::new(&lua);
     let fns = Functions::new(&lua)?;
 
     lua.globals().set("spawn", fns.spawn)?;
@@ -34,7 +34,7 @@ pub fn main() -> LuaResult<()> {
         })?,
     )?;
 
-    // Load the main script into the runtime
+    // Load the main script into the scheduler
     let main = lua.load(MAIN_SCRIPT);
     rt.push_thread_front(main, ())?;
 

examples/scheduler_ordering.rs

@@ -6,7 +6,7 @@ use std::time::{Duration, Instant};
 use async_io::{block_on, Timer};
 
 use mlua::prelude::*;
-use mlua_luau_runtime::{Functions, Runtime};
+use mlua_luau_scheduler::{Functions, Scheduler};
 
 const MAIN_SCRIPT: &str = include_str!("./lua/scheduler_ordering.luau");
 
@@ -19,7 +19,7 @@ pub fn main() -> LuaResult<()> {
 
     // Set up persistent Lua environment
     let lua = Lua::new();
-    let rt = Runtime::new(&lua);
+    let rt = Scheduler::new(&lua);
     let fns = Functions::new(&lua)?;
 
     lua.globals().set("spawn", fns.spawn)?;
@@ -34,7 +34,7 @@ pub fn main() -> LuaResult<()> {
         })?,
     )?;
 
-    // Load the main script into the runtime, and keep track of the thread we spawn
+    // Load the main script into the scheduler, and keep track of the thread we spawn
     let main = lua.load(MAIN_SCRIPT);
     let id = rt.push_thread_front(main, ())?;
 

examples/tracy.rs

@@ -21,7 +21,7 @@ use tracing_subscriber::layer::SubscriberExt;
 use tracing_tracy::{client::Client as TracyClient, TracyLayer};
 
 use mlua::prelude::*;
-use mlua_luau_runtime::{Functions, Runtime};
+use mlua_luau_scheduler::{Functions, Scheduler};
 
 const MAIN_SCRIPT: &str = include_str!("./lua/lots_of_threads.luau");
 
@@ -35,7 +35,7 @@ pub fn main() -> LuaResult<()> {
 
     // Set up persistent Lua environment
     let lua = Lua::new();
-    let rt = Runtime::new(&lua);
+    let rt = Scheduler::new(&lua);
     let fns = Functions::new(&lua)?;
 
     lua.globals().set("spawn", fns.spawn)?;
@@ -49,7 +49,7 @@ pub fn main() -> LuaResult<()> {
         })?,
     )?;
 
-    // Load the main script into the runtime
+    // Load the main script into the scheduler
     let main = lua.load(MAIN_SCRIPT);
     rt.push_thread_front(main, ())?;
 

lib/functions.rs

@@ -9,16 +9,16 @@ use crate::{
     error_callback::ThreadErrorCallback,
     queue::{DeferredThreadQueue, SpawnedThreadQueue},
     result_map::ThreadResultMap,
-    runtime::Runtime,
+    scheduler::Scheduler,
     thread_id::ThreadId,
-    traits::LuaRuntimeExt,
+    traits::LuaSchedulerExt,
     util::{is_poll_pending, LuaThreadOrFunction, ThreadResult},
 };
 
 const ERR_METADATA_NOT_ATTACHED: &str = "\
-Lua state does not have runtime metadata attached!\
-\nThis is most likely caused by creating functions outside of a runtime.\
-\nRuntime functions must always be created from within an active runtime.\
+Lua state does not have scheduler metadata attached!\
+\nThis is most likely caused by creating functions outside of a scheduler.\
+\nScheduler functions must always be created from within an active scheduler.\
 ";
 
 const EXIT_IMPL_LUA: &str = r"
@@ -39,29 +39,29 @@ end
 ";
 
 /**
-    A collection of lua functions that may be called to interact with a [`Runtime`].
+    A collection of lua functions that may be called to interact with a [`Scheduler`].
 */
 pub struct Functions<'lua> {
     /**
         Implementation of `coroutine.resume` that handles async polling properly.
 
-        Defers onto the runtime queue if the thread calls an async function.
+        Defers onto the scheduler queue if the thread calls an async function.
     */
     pub resume: LuaFunction<'lua>,
     /**
         Implementation of `coroutine.wrap` that handles async polling properly.
 
-        Defers onto the runtime queue if the thread calls an async function.
+        Defers onto the scheduler queue if the thread calls an async function.
     */
     pub wrap: LuaFunction<'lua>,
     /**
         Resumes a function / thread once instantly, and runs until first yield.
 
-        Spawns onto the runtime queue if not completed.
+        Spawns onto the scheduler queue if not completed.
     */
     pub spawn: LuaFunction<'lua>,
     /**
-        Defers a function / thread onto the runtime queue.
+        Defers a function / thread onto the scheduler queue.
 
         Does not resume instantly, only adds to the queue.
     */
@@ -71,7 +71,7 @@ pub struct Functions<'lua> {
     */
     pub cancel: LuaFunction<'lua>,
     /**
-        Exits the runtime, stopping all other threads and closing the runtime.
+        Exits the scheduler, stopping all other threads and closing the scheduler.
 
         Yields the calling thread to ensure that it does not continue.
     */
@@ -80,15 +80,15 @@ pub struct Functions<'lua> {
 
 impl<'lua> Functions<'lua> {
     /**
-        Creates a new collection of Lua functions that may be called to interact with a [`Runtime`].
+        Creates a new collection of Lua functions that may be called to interact with a [`Scheduler`].
 
         # Errors
 
         Errors when out of memory, or if default Lua globals are missing.
 
         # Panics
 
-        Panics when the given [`Lua`] instance does not have an attached [`Runtime`].
+        Panics when the given [`Lua`] instance does not have an attached [`Scheduler`].
     */
     pub fn new(lua: &'lua Lua) -> LuaResult<Self> {
         let spawn_queue = lua
@@ -157,7 +157,7 @@ impl<'lua> Functions<'lua> {
         ])?;
         let wrap = lua
             .load(WRAP_IMPL_LUA)
-            .set_name("=__runtime_wrap")
+            .set_name("=__scheduler_wrap")
             .set_environment(wrap_env)
             .into_function()?;
 
@@ -243,7 +243,7 @@ impl<'lua> Functions<'lua> {
         ])?;
         let exit = lua
             .load(EXIT_IMPL_LUA)
-            .set_name("=__runtime_exit")
+            .set_name("=__scheduler_exit")
             .set_environment(exit_env)
             .into_function()?;
 
@@ -260,7 +260,7 @@ impl<'lua> Functions<'lua> {
 
 impl Functions<'_> {
     /**
-        Injects [`Runtime`]-compatible functions into the given [`Lua`] instance.
+        Injects [`Scheduler`]-compatible functions into the given [`Lua`] instance.
 
         This will overwrite the following functions:
 

lib/lib.rs

@@ -3,14 +3,14 @@ mod exit;
 mod functions;
 mod queue;
 mod result_map;
-mod runtime;
+mod scheduler;
 mod status;
 mod thread_id;
 mod traits;
 mod util;
 
 pub use functions::Functions;
-pub use runtime::Runtime;
+pub use scheduler::Scheduler;
 pub use status::Status;
 pub use thread_id::ThreadId;
-pub use traits::{IntoLuaThread, LuaRuntimeExt, LuaSpawnExt};
+pub use traits::{IntoLuaThread, LuaSchedulerExt, LuaSpawnExt};