Struct runa_orbiter::shell::buffers::UserBuffer

pub struct UserBuffer<B, Data> {
    pub data: Data,
    /* private fields */
}

A buffer with additional user data.

Fields

data: Data

The user data

Implementations

impl<B, Data> UserBuffer<B, Data>

pub fn buffer(&self) -> &B

Get a reference to the buffer

pub fn map_buffer<U, F: FnOnce(B) -> U>(self, f: F) -> UserBuffer<U, Data>

Apply a function to the buffer component of a UserBuffer

impl<B, Data> UserBuffer<B, Data>

pub fn new(buffer: B, data: Data) -> Self

Create a new UserBuffer

pub fn with_default_data(buffer: B) -> Selfwhere Data: Default,

Create a new UserBuffer with default data

Trait Implementations

impl<B: BufferLike, Data: Debug + 'static> BufferLike for UserBuffer<B, Data>

fn damage(&self)

Damage the buffer

fn clear_damage(&self)

Clear buffer damage

fn get_damage(&self) -> bool

Returns whether the buffer is damaged

fn dimension(&self) -> Extent<u32, Buffer>

The buffer dimensions

fn object_id(&self) -> u32

Return the object id for the buffer object. Used for sending release event to the client.

fn release(&self)

Send the Released event for this buffer. After this is called, the buffer should prevent any further access of the client resources. Repeated calls to this function without intervening calls to BufferLike::acquire are allowed, but should have no effect.

fn acquire(&self)

Acquire the buffer so it can be read.

impl<B: Debug, Data: Debug> Debug for UserBuffer<B, Data>

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

Formats the value using the given formatter.

impl<U: BufferLike, Data> EventSource<BufferEvent> for UserBuffer<U, Data>

type Source = <U as EventSource<BufferEvent>>::Source

Type of event stream you get from this event source.

fn subscribe(&self) -> Self::Source

Get a stream of events from the event source.

impl<U, T, Data: Default> From<Buffer<T>> for UserBuffer<Buffer<U>, Data>where U: From<T>,

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

Converts to this type from the input type.