Struct DebugTag

#[non_exhaustive]
pub struct DebugTag(/* private fields */);

A value that guarentees that if two DebugTags are not equal, then they are not clones.

This can be used to tag information during debug, such that the use of a value can be tracked and checked. For example, you can use this to ensure (in debug) that a value returned by a data structure is only used with the instance that returned the value.

This tagging is only done if debug_assertions is set. If debug_assertions is not set, then all DebugTags are equal. Even if debug_assertions is set, two DebugTags that are not clones can still be equal. This is unlikely, however.

Therefore, functionality should not directly depend on the equality these tags but only use them for additional sanity checks.

Implementations

impl DebugTag

pub fn new() -> DebugTag

Creates a new DebugTag

pub const fn from(_tag: u32) -> DebugTag

Create a new tag with the specified value.

Prefer using new instead, which will generate a value. Use this only in cases where that is not possible, like when creating a const debug tag.

The tag value should be a randomly chosen constant.

Trait Implementations

impl Clone for DebugTag

fn clone(&self) -> DebugTag

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DebugTag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DebugTag

fn default() -> DebugTag

Returns the “default value” for a type.

impl PartialEq for DebugTag

fn eq(&self, other: &DebugTag) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DebugTag

impl Eq for DebugTag

impl StructuralPartialEq for DebugTag