nvtx 2.0.0

NVIDIA Tools Extension SDK
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

// SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

use crate::Domain;

/// Handle for retrieving a registered string.
///
/// See [`Domain::register_string`] and [`Domain::register_strings`]
#[derive(Debug, Clone, Copy)]
pub struct RegisteredString<'a> {
    handle: nvtx_sys::StringHandle,
    uid: u32,
    domain: &'a Domain,
}

impl PartialEq for RegisteredString<'_> {
    fn eq(&self, other: &Self) -> bool {
        self.handle == other.handle
            && self.uid == other.uid
            && core::ptr::eq(self.domain, other.domain)
    }
}

impl Eq for RegisteredString<'_> {}

impl<'a> RegisteredString<'a> {
    pub(super) fn new(
        handle: nvtx_sys::StringHandle,
        uid: u32,
        domain: &'a Domain,
    ) -> RegisteredString<'a> {
        RegisteredString {
            handle,
            uid,
            domain,
        }
    }

    pub(crate) fn handle(&self) -> nvtx_sys::StringHandle {
        self.handle
    }

    pub(crate) fn domain(&self) -> &Domain {
        self.domain
    }
}