alex/agb
1
0
Fork 0
mirror of https://github.com/italicsjenga/agb.git synced 2024-12-23 16:21:33 +11:00
Code Issues Packages Projects Releases Wiki Activity

Add safety comments to public unsafe functions (#484)

Browse source 
- [x] Changelog updated / no changelog update needed
This commit is contained in:
Corwin 2023-09-14 14:38:45 +02:00 committed by GitHub
parent 71559a28d2 473181718b
commit f0f58741b0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 58 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
agb/examples/object_text_render.rs
View file

@ -24,7 +24,6 @@ fn entry(gba: agb::Gba) -> ! {
fn main(mut gba: agb::Gba) -> ! { fn main(mut gba: agb::Gba) -> ! {
let (mut unmanaged, _sprites) = gba.display.object.get_unmanaged(); let (mut unmanaged, _sprites) = gba.display.object.get_unmanaged();
loop {
let mut palette = [0x0; 16]; let mut palette = [0x0; 16];
palette[1] = 0xFF_FF; palette[1] = 0xFF_FF;
palette[2] = 0x00_FF; palette[2] = 0x00_FF;
@ -96,4 +95,3 @@ fn main(mut gba: agb::Gba) -> ! {
); );
} }
} }
}

4
agb/src/lib.rs
View file

@ -231,6 +231,10 @@ pub struct Gba {
impl Gba { impl Gba {
#[doc(hidden)] #[doc(hidden)]
#[must_use] #[must_use]
/// # Safety
///
/// May only be called a single time. It is not needed to call this due to
/// it being called internally by the [`entry`] macro.
pub unsafe fn new_in_entry() -> Self { pub unsafe fn new_in_entry() -> Self {
Self::single_new() Self::single_new()
} }

2
agb/src/sync/mod.rs
View file

@ -33,6 +33,8 @@ pub fn memory_write_hint<T>(val: *mut T) {
/// This seems to be a problem caused by Rust issue #62256: /// This seems to be a problem caused by Rust issue #62256:
/// <https://github.com/rust-lang/rust/issues/62256> /// <https://github.com/rust-lang/rust/issues/62256>
/// ///
/// # Safety
///
/// **WARNING FOR ANYONE WHO FINDS THIS**: This implementation will *only* be /// **WARNING FOR ANYONE WHO FINDS THIS**: This implementation will *only* be
/// correct on the GBA, and should not be used on any other platform. The GBA /// correct on the GBA, and should not be used on any other platform. The GBA
/// is very old, and has no atomics to begin with - only a main thread and /// is very old, and has no atomics to begin with - only a main thread and