chore: #[must_use] annotations on getters and ctors

kornelski · teoxoy · commit a87c8d77bab1 · 2024-08-19T14:38:05.000+01:00
diff --git a/deno_webgpu/error.rs b/deno_webgpu/error.rs
@@ -68,27 +68,31 @@ pub struct WebGpuResult {
 }
 
 impl WebGpuResult {
+    #[must_use]
     pub fn rid(rid: ResourceId) -> Self {
         Self {
             rid: Some(rid),
             err: None,
         }
     }
 
+    #[must_use]
     pub fn rid_err<T: Into<WebGpuError>>(rid: ResourceId, err: Option<T>) -> Self {
         Self {
             rid: Some(rid),
             err: err.map(Into::into),
         }
     }
 
+    #[must_use]
     pub fn maybe_err<T: Into<WebGpuError>>(err: Option<T>) -> Self {
         Self {
             rid: None,
             err: err.map(Into::into),
         }
     }
 
+    #[must_use]
     pub fn empty() -> Self {
         Self {
             rid: None,
@@ -307,6 +311,7 @@ pub struct DomExceptionOperationError {
 }
 
 impl DomExceptionOperationError {
+    #[must_use]
     pub fn new(msg: &str) -> Self {
         DomExceptionOperationError {
             msg: msg.to_string(),
@@ -322,6 +327,7 @@ impl fmt::Display for DomExceptionOperationError {
 
 impl std::error::Error for DomExceptionOperationError {}
 
+#[must_use]
 pub fn get_error_class_name(e: &AnyError) -> Option<&'static str> {
     e.downcast_ref::<DomExceptionOperationError>()
         .map(|_| "DOMExceptionOperationError")
diff --git a/naga/hlsl-snapshots/src/lib.rs b/naga/hlsl-snapshots/src/lib.rs
@@ -53,6 +53,7 @@ pub struct Config {
 }
 
 impl Config {
+    #[must_use]
     pub fn empty() -> Self {
         Self {
             vertex: Default::default(),
@@ -78,6 +79,7 @@ impl Config {
         fs::write(path, &s).map_err(|e| anyhow!("failed to write to {}: {e}", path.display()))
     }
 
+    #[must_use]
     pub fn is_empty(&self) -> bool {
         let Self {
             vertex,
diff --git a/tests/tests/bind_groups.rs b/tests/tests/bind_groups.rs
@@ -22,7 +22,7 @@ fn try_sampler_nonfiltering_layout(
     let sampler = ctx.device.create_sampler(descriptor);
 
     let create_bind_group = || {
-        ctx.device.create_bind_group(&wgpu::BindGroupDescriptor {
+        let _ = ctx.device.create_bind_group(&wgpu::BindGroupDescriptor {
             label,
             layout: &bind_group_layout,
             entries: &[wgpu::BindGroupEntry {
diff --git a/tests/tests/buffer.rs b/tests/tests/buffer.rs
@@ -220,7 +220,7 @@ static MINIMUM_BUFFER_BINDING_SIZE_LAYOUT: GpuTestConfiguration = GpuTestConfigu
         wgpu_test::fail(
             &ctx.device,
             || {
-                ctx.device
+                let _ = ctx.device
                     .create_compute_pipeline(&wgpu::ComputePipelineDescriptor {
                         label: None,
                         layout: Some(&pipeline_layout),
diff --git a/tests/tests/device.rs b/tests/tests/device.rs
@@ -295,7 +295,8 @@ static DEVICE_DESTROY_THEN_MORE: GpuTestConfiguration = GpuTestConfiguration::ne
         fail(
             &ctx.device,
             || {
-                ctx.device
+                let _ = ctx
+                    .device
                     .create_command_encoder(&wgpu::CommandEncoderDescriptor::default());
             },
             Some("device with '' label is invalid"),
@@ -305,7 +306,7 @@ static DEVICE_DESTROY_THEN_MORE: GpuTestConfiguration = GpuTestConfiguration::ne
         fail(
             &ctx.device,
             || {
-                ctx.device.create_buffer(&wgpu::BufferDescriptor {
+                let _ = ctx.device.create_buffer(&wgpu::BufferDescriptor {
                     label: None,
                     size: 256,
                     usage: wgpu::BufferUsages::MAP_WRITE | wgpu::BufferUsages::COPY_SRC,
@@ -319,7 +320,7 @@ static DEVICE_DESTROY_THEN_MORE: GpuTestConfiguration = GpuTestConfiguration::ne
         fail(
             &ctx.device,
             || {
-                ctx.device.create_texture(&wgpu::TextureDescriptor {
+                let _ = ctx.device.create_texture(&wgpu::TextureDescriptor {
                     label: None,
                     size: wgpu::Extent3d {
                         width: 512,
@@ -458,7 +459,8 @@ static DEVICE_DESTROY_THEN_MORE: GpuTestConfiguration = GpuTestConfiguration::ne
         fail(
             &ctx.device,
             || {
-                ctx.device
+                let _ = ctx
+                    .device
                     .create_bind_group_layout(&wgpu::BindGroupLayoutDescriptor {
                         label: None,
                         entries: &[],
@@ -471,7 +473,7 @@ static DEVICE_DESTROY_THEN_MORE: GpuTestConfiguration = GpuTestConfiguration::ne
         fail(
             &ctx.device,
             || {
-                ctx.device.create_bind_group(&wgpu::BindGroupDescriptor {
+                let _ = ctx.device.create_bind_group(&wgpu::BindGroupDescriptor {
                     label: None,
                     layout: &bind_group_layout,
                     entries: &[wgpu::BindGroupEntry {
@@ -489,7 +491,8 @@ static DEVICE_DESTROY_THEN_MORE: GpuTestConfiguration = GpuTestConfiguration::ne
         fail(
             &ctx.device,
             || {
-                ctx.device
+                let _ = ctx
+                    .device
                     .create_pipeline_layout(&wgpu::PipelineLayoutDescriptor {
                         label: None,
                         bind_group_layouts: &[],
@@ -503,7 +506,8 @@ static DEVICE_DESTROY_THEN_MORE: GpuTestConfiguration = GpuTestConfiguration::ne
         fail(
             &ctx.device,
             || {
-                ctx.device
+                let _ = ctx
+                    .device
                     .create_shader_module(wgpu::ShaderModuleDescriptor {
                         label: None,
                         source: wgpu::ShaderSource::Wgsl(std::borrow::Cow::Borrowed("")),
@@ -516,7 +520,8 @@ static DEVICE_DESTROY_THEN_MORE: GpuTestConfiguration = GpuTestConfiguration::ne
         fail(
             &ctx.device,
             || unsafe {
-                ctx.device
+                let _ = ctx
+                    .device
                     .create_shader_module_spirv(&wgpu::ShaderModuleDescriptorSpirV {
                         label: None,
                         source: std::borrow::Cow::Borrowed(&[]),
@@ -529,7 +534,8 @@ static DEVICE_DESTROY_THEN_MORE: GpuTestConfiguration = GpuTestConfiguration::ne
         fail(
             &ctx.device,
             || {
-                ctx.device
+                let _ = ctx
+                    .device
                     .create_render_pipeline(&wgpu::RenderPipelineDescriptor {
                         label: None,
                         layout: None,
@@ -554,7 +560,8 @@ static DEVICE_DESTROY_THEN_MORE: GpuTestConfiguration = GpuTestConfiguration::ne
         fail(
             &ctx.device,
             || {
-                ctx.device
+                let _ = ctx
+                    .device
                     .create_compute_pipeline(&wgpu::ComputePipelineDescriptor {
                         label: None,
                         layout: None,
@@ -571,7 +578,8 @@ static DEVICE_DESTROY_THEN_MORE: GpuTestConfiguration = GpuTestConfiguration::ne
         fail(
             &ctx.device,
             || {
-                ctx.device
+                let _ = ctx
+                    .device
                     .create_compute_pipeline(&wgpu::ComputePipelineDescriptor {
                         label: None,
                         layout: None,
@@ -852,7 +860,7 @@ static DIFFERENT_BGL_ORDER_BW_SHADER_AND_API: GpuTestConfiguration = GpuTestConf
 
         // fail(&ctx.device, || {
         // }, "");
-        ctx.device.create_bind_group(&wgpu::BindGroupDescriptor {
+        let _ = ctx.device.create_bind_group(&wgpu::BindGroupDescriptor {
             label: None,
             layout: &render_pipeline.get_bind_group_layout(0),
             entries: &[
diff --git a/tests/tests/pipeline.rs b/tests/tests/pipeline.rs
@@ -58,7 +58,8 @@ static NO_TARGETLESS_RENDER: GpuTestConfiguration = GpuTestConfiguration::new()
                 // tries to compile code in an unsupported multisample count. Failing to validate here
                 // has historically resulted in requesting the back end to compile code.
                 for power_of_two in [1, 2, 4, 8, 16, 32, 64] {
-                    ctx.device
+                    let _ = ctx
+                        .device
                         .create_render_pipeline(&wgpu::RenderPipelineDescriptor {
                             label: None,
                             layout: None,
diff --git a/tests/tests/regression/issue_5553.rs b/tests/tests/regression/issue_5553.rs
@@ -24,7 +24,8 @@ static ALLOW_INPUT_NOT_CONSUMED: GpuTestConfiguration =
                 push_constant_ranges: &[],
             });
 
-        ctx.device
+        let _ = ctx
+            .device
             .create_render_pipeline(&RenderPipelineDescriptor {
                 label: Some("Pipeline"),
                 layout: Some(&pipeline_layout),
diff --git a/wgpu-types/src/counters.rs b/wgpu-types/src/counters.rs
@@ -14,6 +14,7 @@ pub struct InternalCounter {
 impl InternalCounter {
     /// Creates a counter with value 0.
     #[inline]
+    #[must_use]
     pub const fn new() -> Self {
         InternalCounter {
             #[cfg(feature = "counters")]
@@ -33,6 +34,7 @@ impl InternalCounter {
     /// Always returns 0 if the `counters` feature is not enabled.
     #[cfg(not(feature = "counters"))]
     #[inline]
+    #[must_use]
     pub fn read(&self) -> isize {
         0
     }
@@ -51,6 +53,7 @@ impl InternalCounter {
     /// Always returns 0 if the `counters` feature is not enabled.
     #[cfg(not(feature = "counters"))]
     #[inline]
+    #[must_use]
     pub fn take(&self) -> isize {
         0
     }
diff --git a/wgpu-types/src/lib.rs b/wgpu-types/src/lib.rs
diff --git a/wgpu/src/api/device.rs b/wgpu/src/api/device.rs

Original file line number	Diff line number	Diff line change
`@@ -68,27 +68,31 @@ pub struct WebGpuResult {`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`impl WebGpuResult {`
	`71`	`+ #[must_use]`
`71`	`72`	`pub fn rid(rid: ResourceId) -> Self {`
`72`	`73`	`Self {`
`73`	`74`	`rid: Some(rid),`
`74`	`75`	`err: None,`
`75`	`76`	`}`
`76`	`77`	`}`
`77`	`78`
	`79`	`+ #[must_use]`
`78`	`80`	`pub fn rid_err<T: Into<WebGpuError>>(rid: ResourceId, err: Option<T>) -> Self {`
`79`	`81`	`Self {`
`80`	`82`	`rid: Some(rid),`
`81`	`83`	`err: err.map(Into::into),`
`82`	`84`	`}`
`83`	`85`	`}`
`84`	`86`
	`87`	`+ #[must_use]`
`85`	`88`	`pub fn maybe_err<T: Into<WebGpuError>>(err: Option<T>) -> Self {`
`86`	`89`	`Self {`
`87`	`90`	`rid: None,`
`88`	`91`	`err: err.map(Into::into),`
`89`	`92`	`}`
`90`	`93`	`}`
`91`	`94`
	`95`	`+ #[must_use]`
`92`	`96`	`pub fn empty() -> Self {`
`93`	`97`	`Self {`
`94`	`98`	`rid: None,`
`@@ -307,6 +311,7 @@ pub struct DomExceptionOperationError {`
`307`	`311`	`}`
`308`	`312`
`309`	`313`	`impl DomExceptionOperationError {`
	`314`	`+ #[must_use]`
`310`	`315`	`pub fn new(msg: &str) -> Self {`
`311`	`316`	`DomExceptionOperationError {`
`312`	`317`	`msg: msg.to_string(),`
`@@ -322,6 +327,7 @@ impl fmt::Display for DomExceptionOperationError {`
`322`	`327`
`323`	`328`	`impl std::error::Error for DomExceptionOperationError {}`
`324`	`329`
	`330`	`+#[must_use]`
`325`	`331`	`pub fn get_error_class_name(e: &AnyError) -> Option<&'static str> {`
`326`	`332`	`e.downcast_ref::<DomExceptionOperationError>()`
`327`	`333`	`.map(\|_\| "DOMExceptionOperationError")`
Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,7 @@ pub struct Config {`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`impl Config {`
	`56`	`+ #[must_use]`
`56`	`57`	`pub fn empty() -> Self {`
`57`	`58`	`Self {`
`58`	`59`	`vertex: Default::default(),`
`@@ -78,6 +79,7 @@ impl Config {`
`78`	`79`	`fs::write(path, &s).map_err(\|e\| anyhow!("failed to write to {}: {e}", path.display()))`
`79`	`80`	`}`
`80`	`81`
	`82`	`+ #[must_use]`
`81`	`83`	`pub fn is_empty(&self) -> bool {`
`82`	`84`	`let Self {`
`83`	`85`	`vertex,`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ pub struct InternalCounter {`
`14`	`14`	`impl InternalCounter {`
`15`	`15`	`/// Creates a counter with value 0.`
`16`	`16`	`#[inline]`
	`17`	`+ #[must_use]`
`17`	`18`	`pub const fn new() -> Self {`
`18`	`19`	`InternalCounter {`
`19`	`20`	`#[cfg(feature = "counters")]`
`@@ -33,6 +34,7 @@ impl InternalCounter {`
`33`	`34`	/// Always returns 0 if the `counters` feature is not enabled.
`34`	`35`	`#[cfg(not(feature = "counters"))]`
`35`	`36`	`#[inline]`
	`37`	`+ #[must_use]`
`36`	`38`	`pub fn read(&self) -> isize {`
`37`	`39`	`0`
`38`	`40`	`}`
`@@ -51,6 +53,7 @@ impl InternalCounter {`
`51`	`53`	/// Always returns 0 if the `counters` feature is not enabled.
`52`	`54`	`#[cfg(not(feature = "counters"))]`
`53`	`55`	`#[inline]`
	`56`	`+ #[must_use]`
`54`	`57`	`pub fn take(&self) -> isize {`
`55`	`58`	`0`
`56`	`59`	`}`