qubit-function 0.16.0

Functional programming traits and Box/Rc/Arc adapters for Rust, inspired by Java functional interfaces
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

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

//! # Common Name Methods Macro
//!
//! Generates common name management methods for function-like structs.

/// Implements common name management methods for function-like structs.
///
/// This macro generates name-management methods for structs that have callback
/// metadata. These methods provide a standardized way to get, set, clear, and
/// chain names for debugging and logging purposes.
///
/// # Parameters
///
/// * `$type_desc:literal` - Description of the type (e.g., "consumer")
///
/// # Generated Methods
///
/// * `name(&self) -> Option<&str>` - Gets the current name if set
/// * `set_name(&mut self, name: &str)` - Sets a new name for the instance
/// * `clear_name(&mut self)` - Clears the current name
/// * `with_name(self, name: &str) -> Self` - Sets a name and returns the
///   instance
macro_rules! impl_common_name_methods {
    ($type_desc:literal) => {
        #[doc = concat!("Gets the name of this ", $type_desc, ".")]
        ///
        /// # Returns
        ///
        /// Returns `Some(&str)` if a name was set, `None` otherwise.
        #[inline(always)]
        pub fn name(&self) -> Option<&str> {
            self.metadata.name()
        }

        #[doc = concat!("Sets the name of this ", $type_desc, ".")]
        ///
        /// # Parameters
        #[doc = concat!("* `name` - The name to set for this ", $type_desc)]
        #[inline(always)]
        pub fn set_name(&mut self, name: &str) {
            self.metadata.set_name(name);
        }

        #[doc = concat!("Clears the name of this ", $type_desc, ".")]
        #[inline(always)]
        pub fn clear_name(&mut self) {
            self.metadata.clear_name();
        }

        #[doc = concat!("Sets the name of this ", $type_desc, " and returns it.")]
        ///
        /// # Parameters
        #[doc = concat!("* `name` - The name to set for this ", $type_desc)]
        ///
        /// # Returns
        ///
        #[doc = concat!("This ", $type_desc, " with the supplied name.")]
        #[inline(always)]
        pub fn with_name(mut self, name: &str) -> Self {
            self.metadata.set_name(name);
            self
        }
    };
}

pub(crate) use impl_common_name_methods;