pub struct Inspectable<V, W>
where W: Watch<V>,
{ /* private fields */ }
Expand description

Generic wrapper for exporting variables via Inspect. Mutations to the wrapped value occur through an InspectableGuard, which notifies the watcher when Dropped, transparently keeping the Inspect state up-to-date.

How the value is exported is determined by the Watch implementation, see e.g. InspectableDebugString.

Not correct for Vs with interior mutability, because Inspectable Derefs to V, mutations to which will bypass the watcher.

Implementations§

source§

impl<V, W> Inspectable<V, W>
where W: Watch<V>,

source

pub fn new(value: V, node: &Node, name: impl Into<StringReference>) -> Self

Creates an Inspectable wrapping value. Exports value via Inspect.

source

pub fn get_mut(&mut self) -> InspectableGuard<'_, V, W>

Returns a guard that DerefMuts to the wrapped value. The watcher will receive the updated value when the guard is Dropped.

Trait Implementations§

source§

impl<V, W> Borrow<V> for Inspectable<V, W>
where W: Watch<V>,

source§

fn borrow(&self) -> &V

Immutably borrows from an owned value. Read more
source§

impl<V, W> Debug for Inspectable<V, W>
where W: Watch<V>, V: Debug,

source§

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

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

impl<V, W> Deref for Inspectable<V, W>
where W: Watch<V>,

§

type Target = V

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl<V, W> Hash for Inspectable<V, W>
where W: Watch<V>, V: Hash,

source§

fn hash<__HVW>(&self, __state: &mut __HVW)
where __HVW: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<V, W> PartialEq for Inspectable<V, W>
where W: Watch<V>, V: PartialEq,

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<V, W> Eq for Inspectable<V, W>
where W: Watch<V>, V: Eq,

Auto Trait Implementations§

§

impl<V, W> Freeze for Inspectable<V, W>
where V: Freeze, W: Freeze,

§

impl<V, W> RefUnwindSafe for Inspectable<V, W>

§

impl<V, W> Send for Inspectable<V, W>
where V: Send, W: Send,

§

impl<V, W> Sync for Inspectable<V, W>
where V: Sync, W: Sync,

§

impl<V, W> Unpin for Inspectable<V, W>
where V: Unpin, W: Unpin,

§

impl<V, W> UnwindSafe for Inspectable<V, W>
where V: UnwindSafe, W: 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
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

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

§

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>,

§

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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