Struct Buffer 

pub struct Buffer { /* private fields */ }

A Luau buffer type.

See the buffer documentation for more information.

Mirrors mlua::Buffer. Holds a registry reference keeping the buffer alive.

Under the send feature it is Send but never Sync — see [crate::sync::NotSync].

Implementations

impl Buffer

pub fn to_vec(&self) -> Vec<u8>

Copies the buffer data into a new Vec<u8>.

Mirrors mlua::Buffer::to_vec.

pub fn len(&self) -> usize

Returns the length of the buffer.

Mirrors mlua::Buffer::len.

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty.

Mirrors mlua::Buffer::is_empty.

pub fn read_bytes<const N: usize>(&self, offset: usize) -> [u8; N]

Reads given number of bytes from the buffer at the given offset.

Offset is 0-based.

Mirrors mlua::Buffer::read_bytes.

pub fn write_bytes(&self, offset: usize, bytes: &[u8])

Writes given bytes to the buffer at the given offset.

Offset is 0-based.

Mirrors mlua::Buffer::write_bytes.

pub fn cursor(self) -> impl Read + Write + Seek

Returns an adaptor implementing io::Read, io::Write and io::Seek over the buffer.

Buffer operations are infallible, none of the read/write functions will return an Err.

Mirrors mlua::Buffer::cursor.

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Buffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Buffer

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

Formats the value using the given formatter.

impl FromLua for Buffer

fn from_lua(value: Value, _lua: &Lua) -> Result<Self>

Perform the conversion.

fn from_lua_arg( arg: Value, _i: usize, _to: Option<&str>, lua: &Lua, ) -> Result<Self>

Convert an argument at 1-based position i. The default forwards to FromLua::from_lua; specific impls can produce nicer messages. Mirrors mlua::FromLua::from_lua_arg.

impl IntoLua for Buffer

fn into_lua(self, _lua: &Lua) -> Result<Value>

Perform the conversion.

impl IntoLua for &Buffer

fn into_lua(self, _lua: &Lua) -> Result<Value>

Perform the conversion.

impl PartialEq for Buffer

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.