Skip to content

Commit 2fc6398

Browse files
committed
Update crate manifests
1 parent 8870c14 commit 2fc6398

11 files changed

Lines changed: 69 additions & 5 deletions

File tree

mfio-derive/Cargo.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ name = "mfio-derive"
33
version = "0.1.0"
44
rust-version = "1.72"
55
edition = "2021"
6+
authors = ["Aurimas Blažulionis <0x60@pm.me>"]
7+
license = "MIT"
8+
repository = "https://github.com/memflow/mfio"
9+
documentation = "https://docs.rs/mfio-derive"
10+
description = "mfio derive macros"
611

712
[lib]
813
proc-macro = true

mfio-netfs/Cargo.toml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
[package]
22
name = "mfio-netfs"
33
version = "0.1.0"
4-
rust-version = "1.72"
4+
rust-version = "1.74"
55
edition = "2021"
6+
authors = ["Aurimas Blažulionis <0x60@pm.me>"]
7+
license = "MIT"
8+
repository = "https://github.com/memflow/mfio"
9+
description = "mfio based network filesystem"
10+
documentation = "https://docs.rs/mfio-netfs"
11+
keywords = [ "mfio", "async", "network", "filesystem" ]
12+
categories = [ "asynchronous", "network-programming", "filesystem" ]
13+
readme = "README.md"
614

715
[[bin]]
816
name = "mfio-netfs-server"

mfio-netfs/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# mfio-netfs
2+
3+
# Network filesystem sample for mfio
4+
5+
This crate is currently just an example showing how a relatively simple filesystem proxy could
6+
be implemented using mfio's TCP streams.
7+
8+
Please do not use this in production, because the library does close to no error checking, so
9+
data corruption is likely to happen.

mfio-netfs/src/lib.rs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
//! # mfio-netfs
2+
//!
3+
//! # Network filesystem sample for mfio
4+
//!
5+
//! This crate is currently just an example showing how a relatively simple filesystem proxy could
6+
//! be implemented using mfio's TCP streams.
7+
//!
8+
//! Please do not use this in production, because the library does close to no error checking, so
9+
//! data corruption is likely to happen.
10+
111
#![cfg_attr(not(feature = "std"), no_std)]
212

313
extern crate alloc;

mfio-netfs/src/net/mod.rs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
pub mod client;
22
pub mod server;
33

4-
pub use client::NetworkFs;
5-
64
use serde::{Deserialize, Serialize};
75

86
use bytemuck::{Pod, Zeroable};

mfio-rt/Cargo.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
[package]
22
name = "mfio-rt"
33
version = "0.1.0"
4-
rust-version = "1.72"
4+
rust-version = "1.74"
55
edition = "2021"
66
authors = ["Aurimas Blažulionis <0x60@pm.me>"]
77
license = "MIT"
88
repository = "https://github.com/memflow/mfio"
99
description = "mfio based async runtime"
10+
documentation = "https://docs.rs/mfio-rt"
11+
keywords = [ "mfio", "async", "runtime", "io_uring", "iocp" ]
12+
categories = [ "asynchronous", "network-programming", "no-std", "os", "filesystem" ]
13+
readme = "README.md"
1014

1115
[package.metadata.docs.rs]
1216
all-features = true

mfio-rt/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# mfio-rt
2+
3+
## mfio Backed Runtime
4+
5+
This crate aims to provide building blocks for mfio backed asynchronous runtimes. The traits
6+
have the option to not rely on the standard library. This makes the system great for `no_std`
7+
embedded environments or kernel-side code.
8+
9+
`native` feature (depends on `std`) enables native implementations of the runtime through
10+
`NativeRt` structure.
11+
12+
`virt` feature enables a virtual in-memory runtime through `VirtRt` structure.
13+
14+
Custom runtimes may be implemented by implementing `IoBackend`, and any of the runtime
15+
traits, such as `Fs` or `Tcp`.

mfio-rt/src/lib.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@
1313
//!
1414
//! Custom runtimes may be implemented by implementing [`IoBackend`], and any of the runtime
1515
//! traits, such as [`Fs`] or [`Tcp`].
16+
//!
17+
//! ## `no_std`
18+
//!
19+
//! Currently, only [`Fs`] is exposed in `no_std` environments. [`Tcp`] depends on structures, such
20+
//! as [`SocketAddr`](https://doc.rust-lang.org/nightly/core/net/enum.SocketAddr.html) that are
21+
//! currently not available in `core`. This will change once
22+
//! [`ip_in_core`](https://github.com/rust-lang/rust/issues/108443) is stabilized.
1623
1724
#![cfg_attr(not(feature = "std"), no_std)]
1825
#![cfg_attr(docsrs, feature(doc_cfg))]

mfio/Cargo.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ edition = "2021"
66
authors = ["Aurimas Blažulionis <0x60@pm.me>"]
77
license = "MIT"
88
repository = "https://github.com/memflow/mfio"
9-
description = "memflow completion-based I/O primitives"
9+
documentation = "https://docs.rs/mfio"
10+
description = "Flexible completion I/O primitives"
11+
keywords = [ "mfio", "memflow", "async", "completion", "io" ]
12+
categories = [ "asynchronous", "no-std", "concurrency" ]
13+
readme = "../README.md"
1014

1115
[package.metadata.docs.rs]
1216
features = ["default", "tokio", "async-io"]

mfio/src/lib.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,10 +176,13 @@ pub(crate) mod std_prelude {
176176
pub mod std {
177177
pub use ::alloc::*;
178178
}
179+
pub use crate::derive::*;
179180
#[cfg(feature = "std")]
180181
pub use ::std;
181182
}
182183

184+
pub use mfio_derive as derive;
185+
183186
pub mod backend;
184187
pub mod error;
185188
#[cfg(feature = "std")]

0 commit comments

Comments
 (0)