qubit-codec 0.16.0

Core codec traits and buffer conversion primitives for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================

//! Value-codec registration source locations.

/// Source location for one linked value-codec registration.
///
/// The four parts are captured at compile time by the registration macros from
/// `CARGO_PKG_NAME`, `module_path!`, `file!`, and `line!`, so they point at the
/// declaration site rather than at the call site that later looks the
/// registration up. Ordering follows declaration order, which makes duplicate
/// reports deterministic.
///
/// # Examples
///
/// ```
/// use qubit_codec::ValueCodecRegistrationSource;
///
/// let source = ValueCodecRegistrationSource::new(
///     "qubit-codec",
///     "my_crate::codecs",
///     "src/codec.rs",
///     42,
/// );
/// assert_eq!(source.crate_name(), "qubit-codec");
/// assert_eq!(source.line(), 42);
/// ```
#[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub struct ValueCodecRegistrationSource {
    /// Package name captured from `CARGO_PKG_NAME` at the declaration site.
    crate_name: &'static str,
    /// Module path captured from `module_path!` at the declaration site.
    module_path: &'static str,
    /// Source file captured from `file!` at the declaration site.
    file: &'static str,
    /// One-based line captured from `line!` at the declaration site.
    line: u32,
}

impl ValueCodecRegistrationSource {
    /// Creates a source location captured by a registration macro.
    ///
    /// # Parameters
    ///
    /// - `crate_name`: Package name captured from `CARGO_PKG_NAME`.
    /// - `module_path`: Module path captured from `module_path!`.
    /// - `file`: Source file captured from `file!`.
    /// - `line`: One-based line captured from `line!`.
    ///
    /// # Returns
    ///
    /// Returns a location that borrows all four captured parts statically.
    ///
    /// Prefer the registration macros over calling this directly.
    #[doc(hidden)]
    #[inline]
    #[must_use]
    pub const fn new(crate_name: &'static str, module_path: &'static str, file: &'static str, line: u32) -> Self {
        Self {
            crate_name,
            module_path,
            file,
            line,
        }
    }

    /// Returns the declaring crate name.
    ///
    /// # Returns
    ///
    /// Returns the `CARGO_PKG_NAME` of the crate that declared the codec.
    #[inline]
    #[must_use]
    pub const fn crate_name(&self) -> &'static str {
        self.crate_name
    }

    /// Returns the declaring module path.
    ///
    /// # Returns
    ///
    /// Returns the `module_path!` value of the declaring module.
    #[inline]
    #[must_use]
    pub const fn module_path(&self) -> &'static str {
        self.module_path
    }

    /// Returns the source file path.
    ///
    /// # Returns
    ///
    /// Returns the `file!` value of the declaring file.
    #[inline]
    #[must_use]
    pub const fn file(&self) -> &'static str {
        self.file
    }

    /// Returns the one-based source line.
    ///
    /// # Returns
    ///
    /// Returns the `line!` value of the declaring macro invocation.
    #[inline]
    #[must_use]
    pub const fn line(&self) -> u32 {
        self.line
    }
}