zrx_id/id/error.rs
1// Copyright (c) 2025-2026 Zensical and contributors
2
3// SPDX-License-Identifier: MIT
4// All contributions are certified under the DCO
5
6// Permission is hereby granted, free of charge, to any person obtaining a copy
7// of this software and associated documentation files (the "Software"), to
8// deal in the Software without restriction, including without limitation the
9// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10// sell copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22// IN THE SOFTWARE.
23
24// ----------------------------------------------------------------------------
25
26//! Identifier error.
27
28use std::result;
29use thiserror::Error;
30
31use crate::id::format;
32
33// ----------------------------------------------------------------------------
34// Enums
35// ----------------------------------------------------------------------------
36
37/// Identifier error.
38#[derive(Debug, Error)]
39pub enum Error {
40 /// Format error.
41 #[error(transparent)]
42 Format(#[from] format::Error),
43 /// Invalid prefix.
44 #[error("invalid prefix")]
45 Prefix,
46 /// Missing component.
47 #[error("missing component: {0}")]
48 Component(&'static str),
49}
50
51// ----------------------------------------------------------------------------
52// Type aliases
53// ----------------------------------------------------------------------------
54
55/// Identifier result.
56pub type Result<T = ()> = result::Result<T, Error>;