Struct BufferKey 

pub struct BufferKey<T> { /* private fields */ }

This key can unlock access to the contents of a buffer by passing it into BufferAccess or BufferAccessMut.

To obtain a BufferKey, use Chain::with_access, or listen.

Implementations

impl<T> BufferKey<T>

pub fn buffer(&self) -> Entity

The buffer ID of this key.

pub fn session(&self) -> Entity

The session that this key belongs to.

pub fn tag(&self) -> &BufferKeyTag

Trait Implementations

impl<T> Accessor for BufferKey<T>

where T: Send + Sync + 'static,

type Buffers = Buffer<T>

fn try_listen_from<'w, 's, 'a, 'b>( buffers: &BufferMap, builder: &'b mut Builder<'w, 's, 'a>, ) -> Result<Chain<'w, 's, 'a, 'b, Self>, IncompatibleLayout>

fn try_buffer_access<T: 'static + Send + Sync>( buffers: &BufferMap, builder: &mut Builder<'_, '_, '_>, ) -> Result<Node<T, (T, Self)>, IncompatibleLayout>

impl<T: 'static + Send + Sync> BufferKeyLifecycle for BufferKey<T>

type TargetBuffer = Buffer<T>

What kind of buffer this key can unlock.

fn create_key(buffer: &Self::TargetBuffer, builder: &BufferKeyBuilder) -> Self

Create a new key of this type.

fn is_in_use(&self) -> bool

Check if the key is currently in use.

fn deep_clone(&self) -> Self

Create a deep clone of the key. The usage tracking of the clone will be unrelated to the usage tracking of the original.

impl<T> Clone for BufferKey<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for BufferKey<T>

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

Formats the value using the given formatter.

impl<T: 'static + Send + Sync + Any> From<BufferKey<T>> for AnyBufferKey

fn from(value: BufferKey<T>) -> Self

Converts to this type from the input type.

impl<T: 'static + Send + Sync + Serialize + DeserializeOwned> From<BufferKey<T>> for JsonBufferKey

fn from(value: BufferKey<T>) -> Self

Converts to this type from the input type.