Update crate manifests

mfio-derive/Cargo.toml

@@ -3,6 +3,11 @@ name = "mfio-derive"
 version = "0.1.0"
 rust-version = "1.72"
 edition = "2021"
+authors = ["Aurimas Blažulionis <0x60@pm.me>"]
+license = "MIT"
+repository = "https://github.com/memflow/mfio"
+documentation = "https://docs.rs/mfio-derive"
+description = "mfio derive macros"
 
 [lib]
 proc-macro = true

mfio-netfs/Cargo.toml

@@ -1,8 +1,16 @@
 [package]
 name = "mfio-netfs"
 version = "0.1.0"
-rust-version = "1.72"
+rust-version = "1.74"
 edition = "2021"
+authors = ["Aurimas Blažulionis <0x60@pm.me>"]
+license = "MIT"
+repository = "https://github.com/memflow/mfio"
+description = "mfio based network filesystem"
+documentation = "https://docs.rs/mfio-netfs"
+keywords = [ "mfio", "async", "network", "filesystem" ]
+categories = [ "asynchronous", "network-programming", "filesystem" ]
+readme = "README.md"
 
 [[bin]]
 name = "mfio-netfs-server"

mfio-netfs/README.md

@@ -0,0 +1,9 @@
+# mfio-netfs
+
+# Network filesystem sample for mfio
+
+This crate is currently just an example showing how a relatively simple filesystem proxy could
+be implemented using mfio's TCP streams.
+
+Please do not use this in production, because the library does close to no error checking, so
+data corruption is likely to happen.

mfio-netfs/src/lib.rs

@@ -1,3 +1,13 @@
+//! # mfio-netfs
+//!
+//! # Network filesystem sample for mfio
+//!
+//! This crate is currently just an example showing how a relatively simple filesystem proxy could
+//! be implemented using mfio's TCP streams.
+//!
+//! Please do not use this in production, because the library does close to no error checking, so
+//! data corruption is likely to happen.
+
 #![cfg_attr(not(feature = "std"), no_std)]
 
 extern crate alloc;

mfio-netfs/src/net/mod.rs

@@ -1,8 +1,6 @@
 pub mod client;
 pub mod server;
 
-pub use client::NetworkFs;
-
 use serde::{Deserialize, Serialize};
 
 use bytemuck::{Pod, Zeroable};

mfio-rt/Cargo.toml

@@ -1,12 +1,16 @@
 [package]
 name = "mfio-rt"
 version = "0.1.0"
-rust-version = "1.72"
+rust-version = "1.74"
 edition = "2021"
 authors = ["Aurimas Blažulionis <0x60@pm.me>"]
 license = "MIT"
 repository = "https://github.com/memflow/mfio"
 description = "mfio based async runtime"
+documentation = "https://docs.rs/mfio-rt"
+keywords = [ "mfio", "async", "runtime", "io_uring", "iocp" ]
+categories = [ "asynchronous", "network-programming", "no-std", "os", "filesystem" ]
+readme = "README.md"
 
 [package.metadata.docs.rs]
 all-features = true

mfio-rt/README.md

@@ -0,0 +1,15 @@
+# mfio-rt
+
+## mfio Backed Runtime
+
+This crate aims to provide building blocks for mfio backed asynchronous runtimes. The traits
+have the option to not rely on the standard library. This makes the system great for `no_std`
+embedded environments or kernel-side code.
+
+`native` feature (depends on `std`) enables native implementations of the runtime through
+`NativeRt` structure.
+
+`virt` feature enables a virtual in-memory runtime through `VirtRt` structure.
+
+Custom runtimes may be implemented by implementing `IoBackend`, and any of the runtime
+traits, such as `Fs` or `Tcp`.

mfio-rt/src/lib.rs

@@ -13,6 +13,13 @@
 //!
 //! Custom runtimes may be implemented by implementing [`IoBackend`], and any of the runtime
 //! traits, such as [`Fs`] or [`Tcp`].
+//!
+//! ## `no_std`
+//!
+//! Currently, only [`Fs`] is exposed in `no_std` environments. [`Tcp`] depends on structures, such
+//! as [`SocketAddr`](https://doc.rust-lang.org/nightly/core/net/enum.SocketAddr.html) that are
+//! currently not available in `core`. This will change once
+//! [`ip_in_core`](https://github.com/rust-lang/rust/issues/108443) is stabilized.
 
 #![cfg_attr(not(feature = "std"), no_std)]
 #![cfg_attr(docsrs, feature(doc_cfg))]

mfio/Cargo.toml

@@ -6,7 +6,11 @@ edition = "2021"
 authors = ["Aurimas Blažulionis <0x60@pm.me>"]
 license = "MIT"
 repository = "https://github.com/memflow/mfio"
-description = "memflow completion-based I/O primitives"
+documentation = "https://docs.rs/mfio"
+description = "Flexible completion I/O primitives"
+keywords = [ "mfio", "memflow", "async", "completion", "io" ]
+categories = [ "asynchronous", "no-std", "concurrency" ]
+readme = "../README.md"
 
 [package.metadata.docs.rs]
 features = ["default", "tokio", "async-io"]

mfio/src/lib.rs

@@ -176,10 +176,13 @@ pub(crate) mod std_prelude {
     pub mod std {
         pub use ::alloc::*;
     }
+    pub use crate::derive::*;
     #[cfg(feature = "std")]
     pub use ::std;
 }
 
+pub use mfio_derive as derive;
+
 pub mod backend;
 pub mod error;
 #[cfg(feature = "std")]

mfio/src/sample.rs

@@ -5,6 +5,7 @@ use mfio::locks::Mutex;
 use core::sync::atomic::{AtomicBool, Ordering};
 use core::task::Waker;
 
+#[allow(unused)]
 use mfio_derive::*;
 
 use tarc::{Arc, BaseArc};