pub struct IOwned<R: Render> { /* private fields */ }
Expand description

Generic smart pointer which owns an inspect subtree (either a Node or a Property) for the duration of its lifetime. It dereferences to the user-provided base type (similar to Arc and other smart pointers). This type should rarely be used declared explictly. Rather, a specific smart pointer (such as IValue) should be used.

Implementations§

source§

impl<R: Render> IOwned<R>

source

pub fn new(value: R::Base) -> Self

Construct the smart pointer but don’t populate any inspect state.

source

pub fn attached(value: R::Base, parent: &Node, name: impl AsRef<str>) -> Self

Construct the smart pointer and populate the inspect state under parent[name].

source

pub fn as_mut(&mut self) -> IOwnedMutGuard<'_, R>

Returns a RAII guard which can be used for mutations. When the guard goes out of scope, the new inspect state is published.

source

pub fn iset(&mut self, value: R::Base)

Set the value, then update inspect state.

source

pub fn into_inner(self) -> R::Base

Trait Implementations§

source§

impl<R, B> Debug for IOwned<R>
where R: Render<Base = B>, B: Debug,

source§

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

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

impl<R, B> Default for IOwned<R>
where R: Render<Base = B>, B: Default,

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<R: Render> Deref for IOwned<R>

§

type Target = <R as Render>::Base

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl<R, B> Display for IOwned<R>
where R: Render<Base = B>, B: Display,

source§

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

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

impl<R: Render> Inspect for &mut IOwned<R>

source§

fn iattach( self, parent: &Node, name: impl AsRef<str> ) -> Result<(), AttachError>

Attaches self to the inspect tree, under parent[name]. Note that: Read more

Auto Trait Implementations§

§

impl<R> Freeze for IOwned<R>
where <R as Render>::Base: Freeze, <R as Render>::Data: Freeze,

§

impl<R> RefUnwindSafe for IOwned<R>
where <R as Render>::Base: RefUnwindSafe, <R as Render>::Data: RefUnwindSafe,

§

impl<R> Send for IOwned<R>
where <R as Render>::Base: Send, <R as Render>::Data: Send,

§

impl<R> Sync for IOwned<R>
where <R as Render>::Base: Sync, <R as Render>::Data: Sync,

§

impl<R> Unpin for IOwned<R>
where <R as Render>::Base: Unpin, <R as Render>::Data: Unpin,

§

impl<R> UnwindSafe for IOwned<R>
where <R as Render>::Base: UnwindSafe, <R as Render>::Data: 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<!> for T

source§

fn from(t: !) -> T

Converts to this type from the input type.
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> ToString for T
where T: Display + ?Sized,

source§

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

§

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

impl<T> WithInspect for T
where &'a mut T: for<'a> Inspect,

source§

fn with_inspect( self, parent: &Node, name: impl AsRef<str> ) -> Result<T, AttachError>

Attaches self to the inspect tree. It is recommended to invoke this as part of construction. For example: Read more
§

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