Add no_std support

Also includes an explicit change to the Cargo.toml to raise the MSRV to 1.69, which ash already requires.

.github/workflows/ci.yml

@@ -18,6 +18,14 @@ jobs:
  - uses: dtolnay/rust-toolchain@1.69.0
  - run: cargo check -p ash -p ash-rewrite -p ash-window -p ash-examples --all-features
 
+ check_no_std:
+ name: Check ash with no_std
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - uses: dtolnay/rust-toolchain@1.69.0
+ - run: cargo check -p ash --no-default-features
+
  # TODO: add a similar job for the rewrite once that generates code
  generated:
  name: Generated

Changelog.md

@@ -31,6 +31,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `descriptor_count()` setter on `ash::vk::WriteDescriptorSet` (#809)
 - Added `*_as_c_str()` getters for `c_char` pointers and `c_char` arrays (#831)
 - Added `#[must_use]` to Vulkan structs to make it more clear that they are moved by the builder pattern (#845)
+- Added `std` feature. Disabling this feature makes ash `no_std` (#664)
 
 ### Changed
 

README.md

@@ -19,6 +19,7 @@ A very lightweight wrapper around Vulkan
 - [x] No validation, everything is **unsafe**
 - [x] Generated from `vk.xml`
 - [x] Support for Vulkan `1.1`, `1.2`, `1.3`
+- [x] `no_std` support
 
 ## ⚠️ Semver compatibility warning
 
@@ -193,6 +194,10 @@ The default `loaded` cargo feature will dynamically load the default Vulkan libr
 
 If, on the other hand, your application cannot handle Vulkan being missing at runtime, you can instead enable the `linked` feature, which will link your binary with the Vulkan loader directly and expose the infallible `Entry::linked`.
 
+### Use in `no_std` environments
+
+Ash can be used in `no_std` environments (with `alloc`) by disabling the `std` feature.
+
 ## Example
 
 You can find the examples [here](https://github.com/ash-rs/ash/tree/master/ash-examples).

ash-examples/Cargo.toml

@@ -12,5 +12,5 @@ winit = "0.28.0"
 # The examples require the validation layers, which means the SDK or
 # equivalent development packages should be present, so we can link
 # directly and benefit from the infallible `Entry` constructor.
-ash = { path = "../ash", default-features = false, features = ["linked", "debug"] }
+ash = { path = "../ash", default-features = false, features = ["linked", "debug", "std"] }
 ash-window = { path = "../ash-window" }

ash-window/Cargo.toml

@@ -19,7 +19,7 @@ edition = "2021"
 rust-version = "1.69.0"
 
 [dependencies]
-ash = { path = "../ash", version = "0.37", default-features = false }
+ash = { path = "../ash", version = "0.37", default-features = false, features = ["std"] }
 raw-window-handle = "0.5"
 
 [target.'cfg(any(target_os = "macos", target_os = "ios"))'.dependencies]

ash/Cargo.toml

@@ -25,13 +25,15 @@ rust-version = "1.69.0"
 libloading = { version = "0.8", optional = true }
 
 [features]
-default = ["loaded", "debug"]
+default = ["loaded", "debug", "std"]
 # Link the Vulkan loader at compile time.
 linked = []
 # Support searching for the Vulkan loader manually at runtime.
-loaded = ["libloading"]
+loaded = ["libloading", "std"]
 # Whether Vulkan structs should implement Debug.
 debug = []
+# Whether the standard library should be required
+std = []
 
 [package.metadata.release]
 no-dev-version = true

ash/src/device.rs

@@ -2,9 +2,10 @@
 use crate::prelude::*;
 use crate::vk;
 use crate::RawPtr;
-use std::mem;
-use std::os::raw::c_void;
-use std::ptr;
+use alloc::vec::Vec;
+use core::ffi::c_void;
+use core::mem;
+use core::ptr;
 
 /// <https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkDevice.html>
 #[derive(Clone)]
@@ -19,7 +20,7 @@ pub struct Device {
 
 impl Device {
  pub unsafe fn load(instance_fn: &vk::InstanceFnV1_0, device: vk::Device) -> Self {
- let load_fn = |name: &std::ffi::CStr| {
+ let load_fn = |name: &core::ffi::CStr| {
  mem::transmute((instance_fn.get_device_proc_addr)(device, name.as_ptr()))
  };
 

ash/src/entry.rs

@@ -2,17 +2,18 @@ use crate::instance::Instance;
 use crate::prelude::*;
 use crate::vk;
 use crate::RawPtr;
-use std::error::Error;
-use std::ffi::CStr;
+use alloc::vec::Vec;
+use core::ffi::c_char;
+use core::ffi::c_void;
+use core::ffi::CStr;
+use core::fmt;
+use core::mem;
+use core::ptr;
+
 #[cfg(feature = "loaded")]
-use std::ffi::OsStr;
-use std::fmt;
-use std::mem;
-use std::os::raw::c_char;
-use std::os::raw::c_void;
-use std::ptr;
+use alloc::sync::Arc;
 #[cfg(feature = "loaded")]
-use std::sync::Arc;
+use std::ffi::OsStr;
 
 #[cfg(feature = "loaded")]
 use libloading::Library;
@@ -337,7 +338,7 @@ impl vk::StaticFn {
  if val.is_null() {
  return Err(MissingEntryPoint);
  } else {
- ::std::mem::transmute(val)
+ ::core::mem::transmute(val)
  }
  },
  })
@@ -351,7 +352,8 @@ impl fmt::Display for MissingEntryPoint {
  write!(f, "Cannot load `vkGetInstanceProcAddr` symbol from library")
  }
 }
-impl Error for MissingEntryPoint {}
+#[cfg(feature = "std")]
+impl std::error::Error for MissingEntryPoint {}
 
 #[cfg(feature = "linked")]
 extern "system" {
@@ -380,8 +382,9 @@ mod loaded {
  }
  }
 
- impl Error for LoadingError {
- fn source(&self) -> Option<&(dyn Error + 'static)> {
+ #[cfg(feature = "std")]
+ impl ::std::error::Error for LoadingError {
+ fn source(&self) -> Option<&(dyn ::std::error::Error + 'static)> {
  Some(match self {
  Self::LibraryLoadFailure(err) => err,
  Self::MissingEntryPoint(err) => err,

ash/src/extensions/amd/buffer_marker.rs

@@ -1,7 +1,7 @@
 use crate::vk;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_AMD_buffer_marker.html>
 #[derive(Clone)]

ash/src/extensions/amd/shader_info.rs

@@ -1,8 +1,9 @@
 use crate::prelude::*;
 use crate::vk;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
+use alloc::vec::Vec;
+use core::ffi::CStr;
+use core::mem;
 
 /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_AMD_shader_info.html>
 #[derive(Clone)]
@@ -43,7 +44,7 @@ impl ShaderInfo {
  vk::ShaderInfoTypeAMD::STATISTICS => {
  let mut statistics_info = mem::MaybeUninit::<vk::ShaderStatisticsInfoAMD>::uninit();
  load_data(
- &mut std::mem::size_of_val(&statistics_info),
+ &mut core::mem::size_of_val(&statistics_info),
  statistics_info.as_mut_ptr().cast(),
  )
  .result()?;

ash/src/extensions/amdx/shader_enqueue.rs

@@ -2,8 +2,9 @@ use crate::prelude::*;
 use crate::vk;
 use crate::RawPtr;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
+use alloc::vec::Vec;
+use core::ffi::CStr;
+use core::mem;
 
 /// <https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VK_AMDX_shader_enqueue.html>
 #[derive(Clone)]

ash/src/extensions/android/external_memory_android_hardware_buffer.rs

@@ -1,8 +1,8 @@
 use crate::prelude::*;
 use crate::vk;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 /// <https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VK_ANDROID_external_memory_android_hardware_buffer.html>
 #[derive(Clone)]

ash/src/extensions/ext/acquire_drm_display.rs

@@ -1,8 +1,8 @@
 use crate::prelude::*;
 use crate::vk;
 use crate::{Entry, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 /// <https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VK_EXT_acquire_drm_display.html>
 #[derive(Clone)]

ash/src/extensions/ext/buffer_device_address.rs

@@ -1,7 +1,7 @@
 use crate::vk;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 #[derive(Clone)]
 pub struct BufferDeviceAddress {

ash/src/extensions/ext/calibrated_timestamps.rs

@@ -1,8 +1,9 @@
 use crate::prelude::*;
 use crate::vk;
 use crate::{Entry, Instance};
-use std::ffi::CStr;
-use std::mem;
+use alloc::vec::Vec;
+use core::ffi::CStr;
+use core::mem;
 
 #[derive(Clone)]
 pub struct CalibratedTimestamps {

ash/src/extensions/ext/debug_marker.rs

@@ -1,8 +1,8 @@
 use crate::prelude::*;
 use crate::vk;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 #[derive(Clone)]
 pub struct DebugMarker {

ash/src/extensions/ext/debug_report.rs

@@ -2,8 +2,8 @@ use crate::prelude::*;
 use crate::vk;
 use crate::RawPtr;
 use crate::{Entry, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 #[derive(Clone)]
 pub struct DebugReport {

ash/src/extensions/ext/debug_utils.rs

@@ -1,8 +1,8 @@
 use crate::prelude::*;
 use crate::{vk, RawPtr};
 use crate::{Entry, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 #[derive(Clone)]
 pub struct DebugUtils {

ash/src/extensions/ext/descriptor_buffer.rs

@@ -1,8 +1,8 @@
 use crate::prelude::*;
 use crate::vk;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 /// <https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VK_EXT_descriptor_buffer.html>
 #[derive(Clone)]

ash/src/extensions/ext/extended_dynamic_state.rs

@@ -1,8 +1,8 @@
 use crate::vk;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
-use std::ptr;
+use core::ffi::CStr;
+use core::mem;
+use core::ptr;
 
 #[derive(Clone)]
 pub struct ExtendedDynamicState {

ash/src/extensions/ext/extended_dynamic_state2.rs

@@ -1,7 +1,7 @@
 use crate::vk;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 /// <https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VK_EXT_extended_dynamic_state2.html>
 #[derive(Clone)]

ash/src/extensions/ext/extended_dynamic_state3.rs

@@ -1,7 +1,7 @@
 use crate::vk;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_EXT_extended_dynamic_state3.html>
 #[derive(Clone)]

ash/src/extensions/ext/full_screen_exclusive.rs

@@ -1,8 +1,9 @@
 use crate::prelude::*;
 use crate::vk;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
+use alloc::vec::Vec;
+use core::ffi::CStr;
+use core::mem;
 
 #[derive(Clone)]
 pub struct FullScreenExclusive {

ash/src/extensions/ext/hdr_metadata.rs

@@ -1,7 +1,7 @@
 use crate::vk;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_EXT_hdr_metadata.html>
 #[derive(Clone)]

ash/src/extensions/ext/headless_surface.rs

@@ -2,8 +2,8 @@ use crate::prelude::*;
 use crate::vk;
 use crate::RawPtr;
 use crate::{Entry, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 /// <https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VK_EXT_headless_surface.html>
 #[derive(Clone)]

ash/src/extensions/ext/host_image_copy.rs

@@ -3,8 +3,8 @@ use super::{super::khr::Maintenance5, ImageCompressionControl};
 use crate::prelude::*;
 use crate::vk;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_EXT_host_image_copy.html>
 #[derive(Clone)]

ash/src/extensions/ext/image_compression_control.rs

@@ -2,8 +2,8 @@
 use super::{super::khr::Maintenance5, HostImageCopy};
 use crate::vk;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 /// <https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VK_EXT_image_compression_control.html>
 #[derive(Clone)]

ash/src/extensions/ext/image_drm_format_modifier.rs

@@ -1,8 +1,8 @@
 use crate::prelude::*;
 use crate::vk;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 /// <https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VK_EXT_image_drm_format_modifier.html>
 #[derive(Clone)]

ash/src/extensions/ext/mesh_shader.rs

@@ -1,7 +1,7 @@
 use crate::vk;
 use crate::{Device, Instance};
-use std::ffi::CStr;
-use std::mem;
+use core::ffi::CStr;
+use core::mem;
 
 /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_EXT_mesh_shader.html>
 #[derive(Clone)]