getopt-rs(3): added getopt library for Rust

src/getopt-rs/error.rs

@@ -0,0 +1,95 @@
+/*
+ * Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Affero General Public License as published by the Free
+ * Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ * 
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see https://www.gnu.org/licenses/.
+ *
+ * This file incorporates work covered by the following copyright and permission
+ * notice:
+ *     The Clear BSD License
+ *
+ *     Copyright © 2017-2023 David Wildasin
+ *     All rights reserved.
+ *
+ *     Redistribution and use in source and binary forms, with or without
+ *     modification, are permitted (subject to the limitations in the disclaimer
+ *     below) provided that the following conditions are met:
+ *
+ *          * Redistributions of source code must retain the above copyright
+ *          notice, this list of conditions, and the following disclaimer.
+ *
+ *          * Redistributions in binary form must reproduce the above copyright
+ *          notice, this list of conditions, and the following disclaimer in the
+ *          documentation and/or other materials provided with the distribution.
+ *
+ *          * Neither the name of the copyright holder nor the names of its
+ *          contributors may be used to endorse or promote products derived from
+ *          this software without specific prior written permission.
+ *
+ *     NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
+ *     BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+ *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
+ *     BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ *     FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *     HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ *     TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ *     PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ *     LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ *     NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ *     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+use std::{ error, fmt };
+
+use crate::ErrorKind::{ self, * };
+
+/// A basic error type for [`Parser`](struct.Parser.html)
+#[derive(Debug, Eq, PartialEq)]
+pub struct Error {
+    culprit: char,
+    kind: ErrorKind,
+}
+
+impl Error {
+    /// Creates a new error using a known kind and the character that caused the
+	/// issue.
+    pub fn new(kind: ErrorKind, culprit: char) -> Self {
+        Self { culprit, kind }
+    }
+
+    /// Returns the [`ErrorKind`](enum.ErrorKind.html) for this error.
+    pub fn kind(self) -> ErrorKind {
+        self.kind
+    }
+}
+
+impl fmt::Display for Error {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        match self.kind {
+            MissingArgument => write!(
+				f, 
+				"option requires an argument -- {:?}",
+				self.culprit,
+			),
+            UnknownOption => write!(f, "unknown option -- {:?}", self.culprit),
+        }
+    }
+}
+
+impl error::Error for Error {
+    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
+        None
+    }
+}