Add the #[must_use] attribute to the Input trait

magicant · Aug 27, 2024 · 112163d · 112163d
1 parent 2e6f374
commit 112163d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/yash-syntax/CHANGELOG.md b/yash-syntax/CHANGELOG.md
@@ -5,6 +5,12 @@ All notable changes to `yash-syntax` will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.11.1] - Unreleased
+
+### Changed
+
+- The `input::Input` trait is now `#[must_use]`.
+
 ## [0.11.0] - 2024-08-22
 
 ### Added
@@ -315,6 +321,7 @@ command.
 - Functionalities to parse POSIX shell scripts
 - Alias substitution support
 
+[0.11.1]: https://github.com/magicant/yash-rs/releases/tag/yash-syntax-0.11.1
 [0.11.0]: https://github.com/magicant/yash-rs/releases/tag/yash-syntax-0.11.0
 [0.10.0]: https://github.com/magicant/yash-rs/releases/tag/yash-syntax-0.10.0
 [0.9.0]: https://github.com/magicant/yash-rs/releases/tag/yash-syntax-0.9.0

diff --git a/yash-syntax/src/input.rs b/yash-syntax/src/input.rs
@@ -65,6 +65,7 @@ pub type Result = std::result::Result<String, Error>;
 ///
 /// An `Input` object provides the parser with source code by reading from underlying source.
 #[async_trait(?Send)]
+#[must_use = "Input instances should be used by a parser"]
 pub trait Input {
     /// Reads a next line of the source code.
     ///