Struct BufferHandle

pub struct BufferHandle { /* private fields */ }

A handle to a buffer that was created in the current plugin.

This means that the plugin owns this buffer. Nevertheless Weechat can invalidate the buffer between callbacks at any point in time.

The buffer handle can be upgraded to a buffer which can then manipulate the buffer state using the upgrade() method.

The buffer won’t be closed if this handle gets dropped, to close the buffer call the close method on the upgraded buffer object.

Implementations

impl BufferHandle

pub fn upgrade(&self) -> Result<Buffer<'_>, ()>

Upgrade the buffer handle into a Buffer.

This is necessary to do because the handle can be invalidated by Weechat between callbacks.

Trait Implementations

impl Clone for BufferHandle

fn clone(&self) -> BufferHandle

Returns a copy of the value.

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

Performs copy-assignment from source.