v1.0.0

🚨 THIS IS A BREAKING CHANGE RELEASE! 🚨

Your code has broken. You will need to change it in order to use this. This work on your part is worth it.

This release has a great deal of changes from the 0.22 development series! Most breaking changes should have reasonable error messages indicating how they can be repaired.

Removed APIs do not have deprecation notices! Use of removed APIs will fail to compile. You must check this changelog, or the crate documentation, to find out appropriate replacements.

Type Parameter Reördering

The <O, T> type parameter pair that has existed since 0.10 is reversed to be <T, O>! This will cause all of your type definitions to fail, as suddenly all of your chosen type arguments do not satisfy the demanded traits.

This change was made in accordance with [Issue #​136], requested by GitHub user [@​changhe3].

Additional Changes

• The MSRV is raised to 1.56.
• BitField now supports signed integers! BitMemory is completely removed.
• BitSlice::from_slice{,_mut} are now infallible constructors, and panic when the source is too long. The original fallible behavior is renamed to BitSlice::try_from_slice{,_mut}.
• the {Bit,}DomainMut types have been removed. The {Bit,}Domain types now take a Mutability type parameter instead. The .{bit_,}domain{,_mut}() methods on BitSlice exist as normal, but have changed their return types to specify a Const or Mut type parameter rather than {Bit,}Domain or {Bit,}DomainMut, respectively.
• Iter::by_{ref,val} are renamed to by_{ref,val}s, to prevent collision with Iterator::by_ref.
• The long-standing behavior of the &=, |=, and ^= operators has been changed! They now operate directly on data structures, rather than routing through iterators. If you want to perform boolean arithmetic using arbitrary bool streams, use iterator combinators like .iter_mut().zip(stream).for_each(|(mut orig, new)| *orig ^= new). This change allows the arithmetic implementations to be accelerated when working between bit-slices of equal types.
• BitSlice::set_all is removed, as the standard-library API [T]::fill replaces it.
• BitSlice::offset_from is removed. Use .as_bitptr().offset_from().
• BitSlice::as_raw_slice is removed. Use .domain() to access the underlying memory.

Documentation

Module and type documentation have been lifted into the doc/ tree as Markdown files. The [user guide], in book/ has been more thoroughly rewritten.

Please file any problems or confusions about the documentation as an issue! The documentation is a project artifact equally, if not more, important as the Rust library.

Dependency Raises

As part of the migration of incidental logic out of bitvec, the following utility libraries have been updated:

• funty 2.0 provides a more comprehensive coverage of the language primitives.
• wyz 0.5 contains more logic formerly in the utility module, as well as a stronger system for generalizing over references.

v0.9.1

Compare Source

• Add safe constructor and initialization for Heap (#​55)
• Merge front/back padding after allocate current hole (#​54)

v0.9.3

Added

• Implemented Default for Once
• Once::try_call_once

Fixed

• Fixed bug that caused Once::call_once to incorrectly fail

v0.14.9

Compare Source

New Features

• Address in VirtAddrNotValid and PhysAddrNotValid is now public https://togithub.com/rust-osdev/x86_64/pull/340x86_64/pull/340)).
  • This field now contains the whole invalid address https://togithub.com/rust-osdev/x86_64/pull/347x86_64/pull/347)).
• Remove all uses of external assembly https://togithub.com/rust-osdev/x86_64/pull/343x86_64/pull/343))
  • external_asm and inline_asm features are deprecated and now have no effect.
  • instructions feature (on by default) now requires Rust 1.59
  • Specific MSRV now noted in README https://togithub.com/rust-osdev/x86_64/pull/355x86_64/pull/355))
• Implement core::iter::Step for VirtAddr and Page https://togithub.com/rust-osdev/x86_64/pull/342x86_64/pull/342))
  • This trait is only available on nightly.
  • Gated behind step_trait feature flag
• Add UCet and SCet registers https://togithub.com/rust-osdev/x86_64/pull/349x86_64/pull/349))
• Use rustversion to mark certian functions const fn on Rust 1.61 https://togithub.com/rust-osdev/x86_64/pull/353x86_64/pull/353))
• Entry::handler_addr() is now public https://togithub.com/rust-osdev/x86_64/pull/354x86_64/pull/354))
• Increase packed structure alignment https://togithub.com/rust-osdev/x86_64/pull/362x86_64/pull/362))
• Make more address methods const fn https://togithub.com/rust-osdev/x86_64/pull/369x86_64/pull/369))
  • VirtAddr::as_ptr()
  • VirtAddr::as_mut_ptr()
  • PhysAddr::new()
  • PhysAddr::try_new()

Bug fixes and Documentation

• Fixed overflow bug in PageRangeInclusive https://togithub.com/rust-osdev/x86_64/pull/351x86_64/pull/351))
• Remove stabilized const_fn_fn_ptr_basics and const_fn_trait_bound features https://togithub.com/rust-osdev/x86_64/pull/352x86_64/pull/352))
• Don't set nomem in load_tss https://togithub.com/rust-osdev/x86_64/pull/358x86_64/pull/358))
• Correctly initialize TSS's IOPB to be empty https://togithub.com/rust-osdev/x86_64/pull/357x86_64/pull/357))
• Improve GlobalDescriptorTable::add_entry error handling https://togithub.com/rust-osdev/x86_64/pull/361x86_64/pull/361))
• Update tss_segment documentation https://togithub.com/rust-osdev/x86_64/pull/366x86_64/pull/366))

v0.14.8

Compare Source

• Add Cr2::read_raw https://togithub.com/rust-osdev/x86_64/pull/334x86_64/pull/334))
• Add support for MXCSR register https://togithub.com/rust-osdev/x86_64/pull/336x86_64/pull/336))

v0.14.7

Compare Source

• fix: build error on the latest nightly https://togithub.com/rust-osdev/x86_64/pull/329x86_64/pull/329))
• add set_general_handler macro https://togithub.com/rust-osdev/x86_64/pull/285x86_64/pull/285))
• Derive common traits for number, range and enum types https://togithub.com/rust-osdev/x86_64/pull/315x86_64/pull/315))
• Add the VMM Communication Exception (#VC) to the InterruptDescriptorTable https://togithub.com/rust-osdev/x86_64/pull/313x86_64/pull/313))
• fix: enable manipulation of InterruptStackFrame https://togithub.com/rust-osdev/x86_64/pull/312x86_64/pull/312))
• fix docs for page_table_index https://togithub.com/rust-osdev/x86_64/pull/318x86_64/pull/318))
• Remove redundant alignment check https://togithub.com/rust-osdev/x86_64/pull/314x86_64/pull/314))
• fix(idt): fix panic messages for index and #VC https://togithub.com/rust-osdev/x86_64/pull/321x86_64/pull/321))
• remove const_assert! in favor of std's assert! https://togithub.com/rust-osdev/x86_64/pull/326x86_64/pull/326))
• Move bootloader integration test to separate CI job https://togithub.com/rust-osdev/x86_64/pull/330x86_64/pull/330))

v0.3.2

• fixes potential UB due to insufficiently strict bounds on Sync implementation for OnceCell (see Issue #​3)

v0.3.1

Compare Source

• fixes an apparent regression, requiring a new compiler than the stated 1.36.0

v0.3.0

• mostly internal refactorings
• adds the noblock module containing types which only allow non-blocking initialization
• raw is renamed to doc and hidden from documentation, but linked to from within the docs
• the Spin marker type is no longer exported

Release 0.3.1

• fixes an apparent regression, requiring a new compiler than the stated 1.36.0

Release 0.3.2

• fixes potential UB due to insufficiently strict bounds on Sync implementation for OnceCell (see Issue #​3)

v0.2.1

• updates docs to explicitly specify the concrete synchronization guarantees

v0.3.21

Compare Source

• Fix potential data race in FlattenUnordered that introduced in 0.3.20 (#​2566)

v0.3.20

Compare Source

NOTE: This release has been yanked due to a bug fixed in 0.3.21.

• Fix stacked borrows violations when -Zmiri-tag-raw-pointers is enabled. This raises MSRV of futures-task to 1.45. (#​2548, #​2550)
• Change FuturesUnordered to respect yielding from future (#​2551)
• Add StreamExt::{flatten_unordered, flat_map_unordered} (#​2083)

v0.3.19

Compare Source

• Remove unstable read-initializer feature (#​2534)
• Fix panic in FuturesUnordered (#​2535)
• Fix compatibility issue with FuturesUnordered and tokio's cooperative scheduling (#​2527)
• Add StreamExt::count (#​2495)

v0.3.18

Compare Source

NOTE: This release has been yanked. See #​2529 for details.

• Fix unusable Sink implementation on stream::Scan (#​2499)
• Make task::noop_waker_ref available without std feature (#​2505)
• Add async LineWriter (#​2477)
• Remove dependency on proc-macro-hack. This raises MSRV of utility crates to 1.45. (#​2520)

v0.3.17

Compare Source

• Use FuturesOrdered in join_all (#​2412)
• Add {future, stream}::poll_immediate (#​2452)
• Add stream_select! macro (#​2262)
• Implement Default for OptionFuture (#​2471)
• Add Peekable::{peek_mut, poll_peek_mut} (#​2488)
• Add BufReader::seek_relative (#​2489)

v0.3.16

Compare Source

• Add TryStreamExt::try_chunks (#​2438)
• Add StreamExt::{all, any} (#​2460)
• Add stream::select_with_strategy (#​2450)
• Update to new io_slice_advance interface (#​2454)

v0.3.15

Compare Source

• Use #[proc_macro] at Rust 1.45+ to fix an issue where proc macros don't work with rust-analyzer (#​2407)
• Support targets that do not have atomic CAS on stable Rust (#​2400)
• futures-test: Add async #[test] function attribute (#​2409)
• Add stream::abortable (#​2410)
• Add FuturesUnordered::clear (#​2415)
• Implement IntoIterator for FuturesUnordered (#​2423)
• Implement Send and Sync for FuturesUnordered iterators (#​2416)
• Make FuturesUnordered::iter_pin_ref public (#​2423)
• Add SelectAll::clear (#​2430)
• Add SelectAll::{iter, iter_mut} (#​2428)
• Implement IntoIterator for SelectAll (#​2428)
• Implement Clone for WeakShared (#​2396)

v0.3.14

Compare Source

• Add future::SelectAll::into_inner (#​2363)
• Allow calling UnboundedReceiver::try_next after None (#​2369)
• Reexport non-Ext traits from the root of futures_util (#​2377)
• Add AsyncSeekExt::stream_position (#​2380)
• Add stream::Peekable::{next_if, next_if_eq} (#​2379)

v0.3.13

Compare Source

• Mitigated starvation issues in FuturesUnordered (#​2333)
• Fixed race with dropping mpsc::Receiver (#​2304)
• Added Shared::{strong_count, weak_count} (#​2346)
• Added no_std support for task::noop_waker_ref (#​2332)
• Implemented Stream::size_hint for Either (#​2325)

v0.3.12

Compare Source

• Fixed Unpin impl of future::{MaybeDone, TryMaybeDone} where trait bounds were accidentally added in 0.3.9. (#​2317)

v0.3.11

Compare Source

• Fixed heap buffer overflow in AsyncReadExt::{read_to_end, read_to_string} (#​2314)

v0.3.10

Compare Source

NOTE: This release has been yanked. See #​2310 for details.

• Fixed type-inference in sink::unfold by specifying more of its types (breaking change -- see #​2311)

v0.3.9

Compare Source

NOTE: This release has been yanked. See #​2310 for details.

• Significantly improved compile time when async-await crate feature is disabled (#​2273)
• Added stream::repeat_with (#​2279)
• Added StreamExt::unzip (#​2263)
• Added sink::unfold (#​2268)
• Added SinkExt::feed (#​2155)
• Implemented FusedFuture for oneshot::Receiver (#​2300)
• Implemented Clone for sink::With (#​2290)
• Re-exported MapOkOrElse, MapInto, OkInto, TryFlatten, WriteAllVectored (#​2275)

v0.3.8

Compare Source

NOTE: This release has been yanked. See #​2310 for details.

• Switched proc-macros to use native #[proc_macro] at Rust 1.45+ (#​2243)
• Added WeakShared (#​2169)
• Added TryStreamExt::try_buffered (#​2245)
• Added StreamExt::cycle (#​2252)
• Implemented Clone for stream::{Empty, Pending, Repeat, Iter} (#​2248, #​2252)
• Fixed panic in some TryStreamExt combinators (#​2250)

v0.3.7

Compare Source

NOTE: This release has been yanked. See #​2310 for details.

• Fixed unsoundness in MappedMutexGuard (#​2240)
• Re-exported TakeUntil (#​2235)
• futures-test: Prevent double panic in panic_waker (#​2236)

v0.3.6

Compare Source

NOTE: This release has been yanked. See #​2310 for details.

• Fixed UB due to missing 'static on task::waker (#​2206)
• Added AsyncBufReadExt::fill_buf (#​2225)
• Added TryStreamExt::try_take_while (#​2212)
• Added is_connected_to method to mpsc::{Sender, UnboundedSender} (#​2179)
• Added is_connected_to method to oneshot::Sender (#​2158)
• Implement FusedStream for FuturesOrdered (#​2205)
• Fixed documentation links
• Improved documentation
• futures-test: Added track_closed method to AsyncWriteTestExt and SinkTestExt (#​2159)
• futures-test: Implemented more traits for InterleavePending (#​2208)
• futures-test: Implemented more traits for AssertUnmoved (#​2208)

v0.3.5

Compare Source

NOTE: This release has been yanked. See #​2310 for details.

• Added StreamExt::flat_map.
• Added StreamExt::ready_chunks.
• Added *_unpin methods to SinkExt.
• Added a cancellation() future to oneshot::Sender.
• Added reunite method to ReadHalf and WriteHalf.
• Added Extend implementations for Futures(Un)Ordered and SelectAll.
• Added support for reexporting the join! and select! macros.
• Added no_std support for the pending! and poll! macros.
• Added Send and Sync support for AssertUnmoved.
• Fixed a bug where Shared wasn't relinquishing control to the executor.
• Removed the Send bound on the output of RemoteHandle.
• Relaxed bounds on FuturesUnordered.
• Reorganized internal tests to work under different --features.
• Reorganized the bounds on StreamExt::forward.
• Removed and replaced a large amount of internal unsafe.

• Schedule: ["at any time"]
• Branch name: renovate/rust-futures-monorepo
• Merge into: main
• Upgrade futures-util to 0.3.21

• Branch name: renovate/crate-conquer-once-vulnerability
• Merge into: main
• Upgrade conquer-once to 0.3.2

• Schedule: ["at any time"]
• Branch name: renovate/linked_list_allocator-0.x
• Merge into: main
• Upgrade linked_list_allocator to 0.9.1

• Schedule: ["at any time"]
• Branch name: renovate/spin-0.x
• Merge into: main
• Upgrade spin to 0.9.3

• Schedule: ["at any time"]
• Branch name: renovate/x86_64-0.x
• Merge into: main
• Upgrade x86_64 to 0.14.9

• Schedule: ["at any time"]
• Branch name: renovate/bitvec-1.x
• Merge into: main
• Upgrade bitvec to 1.0

v0.10.1

Compare Source

• Fixed logic for freeing nodes (#​64)

v0.10.0

Compare Source

• Changed constructor to take *mut u8 instead of usize (#​62)
  • NOTE: Breaking API change
• Reworked internals to pass Miri tests (#​62)

v0.9.4

Fixed

• Fixed unsoundness in RwLock on reader overflow
• Relaxed Send/Sync bounds for SpinMutex and TicketMutex (doesn't affect Mutex itself)

v0.14.10

Compare Source

New Features

• https://togithub.com/rust-osdev/x86_64/pull/286rust-osdev/x86_64/pull/286)
• https://togithub.com/rust-osdev/x86_64/pull/373 constant on SegmentSelector](https://togithub.com/rust-osdev/x86_64/pull/373)
• https://togithub.com/rust-osdev/x86_64/pull/385g](https://togithub.com/rust-osdev/x86_64/pull/385)

Fixes

• https://togithub.com/rust-osdev/x86_64/pull/375t-osdev/x86_64/pull/375)
• https://togithub.com/rust-osdev/x86_64/pull/374ust-osdev/x86_64/pull/374)

Other Improvements

• https://togithub.com/rust-osdev/x86_64/pull/376rust-osdev/x86_64/pull/376)
• https://togithub.com/rust-osdev/x86_64/pull/382/rust-osdev/x86_64/pull/382)

kernel/Cargo.toml

• log 0.4
• x86_64 0.14.9
• spin 0.9.3
• lazy_static 1.4.0
• arrayvec 0.7.2
• linked_list_allocator 0.9.1
• crossbeam 0.8.1
• conquer-once 0.3.2
• futures-util 0.3.21
• bitvec 1.0
• bitflags 1.3.2

.github/actions/cache_cargo/action.yaml

• actions/cache v3

.github/workflows/ci.yaml

• actions/checkout v3
• actions/checkout v3
• actions/checkout v3