TrackedVariable

Struct TrackedVariable 

Source
pub struct TrackedVariable<T: Trackable> { /* private fields */ }
Expand description

A wrapper that provides automatic lifecycle tracking for variables.

This struct wraps any Trackable type and automatically handles:

  • Creation tracking when constructed
  • Destruction tracking when dropped with duplicate protection
  • Transparent access to the wrapped value via Deref/DerefMut
  • Smart pointer detection and specialized handling for Rc, Arc, and Box
  • Thread-safe drop protection using atomic flags
  • Panic-safe error handling in drop logic

§Key Features:

  • Drop Protection: Prevents duplicate destruction tracking
  • Smart Pointer Support: Automatic detection and handling of reference-counted types
  • Error Resilience: Robust error handling that won’t crash on tracking failures
  • Thread Safety: Uses atomic operations for safe concurrent access
  • Zero-Cost Abstraction: Transparent access to wrapped value with minimal overhead

Implementations§

Source§

impl<T: Trackable> TrackedVariable<T>

Source

pub fn new(value: T, var_name: String) -> Self

Create a new tracked variable wrapper.

Source

pub fn get(&self) -> &T

Get a reference to the inner value.

Source

pub fn get_mut(&mut self) -> &mut T

Get a mutable reference to the inner value.

Source

pub fn into_inner(self) -> T

Consume the wrapper and return the inner value.

This method safely extracts the wrapped value while ensuring that destruction tracking occurs exactly once. It uses atomic protection to prevent duplicate tracking even if the Drop trait would normally execute afterwards.

§Safety Features:
  • Uses ManuallyDrop to prevent automatic Drop execution
  • Atomic flag prevents duplicate destruction tracking
  • Proper error handling for tracking failures
  • Smart pointer detection for specialized handling

Trait Implementations§

Source§

impl<T: Trackable + Clone> Clone for TrackedVariable<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Trackable + Debug> Debug for TrackedVariable<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Trackable> Deref for TrackedVariable<T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<T: Trackable> DerefMut for TrackedVariable<T>

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Source§

impl<T: Trackable + Display> Display for TrackedVariable<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Trackable> Drop for TrackedVariable<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<T> !Freeze for TrackedVariable<T>

§

impl<T> RefUnwindSafe for TrackedVariable<T>
where T: RefUnwindSafe,

§

impl<T> Send for TrackedVariable<T>
where T: Send,

§

impl<T> Sync for TrackedVariable<T>
where T: Sync,

§

impl<T> Unpin for TrackedVariable<T>
where T: Unpin,

§

impl<T> UnwindSafe for TrackedVariable<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more