Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New design based on *mut T #22

Merged
merged 17 commits into from
Jun 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,16 @@ repository = "https://github.com/rust-osdev/volatile"
[features]
# Enable unstable features; requires Rust nightly; might break on compiler updates
unstable = []
# Enable unstable and experimental features; requires Rust nightly; might break on compiler updates
very_unstable = ["unstable"]

[dev-dependencies]
rand = "0.8.3"

[package.metadata.release]
no-dev-version = true
pre-release-replacements = [
{ file="Changelog.md", search="# Unreleased", replace="# Unreleased\n\n# {{version}} – {{date}}", exactly=1 },
{ file = "Changelog.md", search = "# Unreleased", replace = "# Unreleased\n\n# {{version}} – {{date}}", exactly = 1 },
]
pre-release-commit-message = "Release version {{version}}"

Expand Down
60 changes: 43 additions & 17 deletions src/access.rs
Original file line number Diff line number Diff line change
@@ -1,22 +1,48 @@
/// Helper trait that is implemented by [`ReadWrite`] and [`ReadOnly`].
pub trait Readable {}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct NoAccess;

/// Helper trait that is implemented by [`ReadWrite`] and [`WriteOnly`].
pub trait Writable {}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct UnsafeAccess;

/// Zero-sized marker type for allowing both read and write access.
#[derive(Debug, Copy, Clone)]
pub struct ReadWrite;
impl Readable for ReadWrite {}
impl Writable for ReadWrite {}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct SafeAccess;

/// Zero-sized marker type for allowing only read access.
#[derive(Debug, Copy, Clone)]
pub struct ReadOnly;
pub trait Unsafe {}
pub trait Safe: Unsafe {}

impl Readable for ReadOnly {}
impl Unsafe for UnsafeAccess {}
impl Unsafe for SafeAccess {}
impl Safe for SafeAccess {}

/// Zero-sized marker type for allowing only write access.
#[derive(Debug, Copy, Clone)]
pub struct WriteOnly;
impl Writable for WriteOnly {}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Access<R, W> {
pub read: R,
pub write: W,
}

impl Access<SafeAccess, NoAccess> {
pub const fn read_only() -> ReadOnly {
Access {
read: SafeAccess,
write: NoAccess,
}
}

pub const fn write_only() -> WriteOnly {
Access {
read: NoAccess,
write: SafeAccess,
}
}

pub const fn read_write() -> ReadWrite {
Access {
read: SafeAccess,
write: SafeAccess,
}
}
}
Comment on lines +18 to +44

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we got rid of the need to pass Access by value and instead just referred to the type, we could delete all these type methods, and also just define Access like:

pub struct Access<R, W>(R, W);


pub type ReadOnly = Access<SafeAccess, NoAccess>;
pub type WriteOnly = Access<NoAccess, SafeAccess>;
pub type ReadWrite = Access<SafeAccess, SafeAccess>;
Loading