Struct mlua::String

pub struct String<'lua>(_);

Handle to an internal Lua string.

Unlike Rust strings, Lua strings may not be valid UTF-8.

Methods

impl<'lua> String<'lua>

pub fn to_str(&self) -> Result<&str>

Get a &str slice if the Lua string is valid UTF-8.

Examples

let globals = lua.globals();

let version: String = globals.get("_VERSION")?;
assert!(version.to_str()?.contains("Lua"));

let non_utf8: String = lua.load(r#"  "test\255"  "#).eval()?;
assert!(non_utf8.to_str().is_err());

pub fn as_bytes(&self) -> &[u8]

Get the bytes that make up this string.

The returned slice will not contain the terminating nul byte, but will contain any nul bytes embedded into the Lua string.

Examples

let non_utf8: String = lua.load(r#"  "test\255"  "#).eval()?;
assert!(non_utf8.to_str().is_err());    // oh no :(
assert_eq!(non_utf8.as_bytes(), &b"test\xff"[..]);

pub fn as_bytes_with_nul(&self) -> &[u8]

Get the bytes that make up this string, including the trailing nul byte.

Trait Implementations

impl<'lua> AsRef<[u8]> for String<'lua>

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl<'lua> Clone for String<'lua>

fn clone(&self) -> String<'lua>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'lua> Debug for String<'lua>

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

Formats the value using the given formatter.

impl<'lua> FromLua<'lua> for String<'lua>

fn from_lua(value: Value<'lua>, lua: &'lua Lua) -> Result<String<'lua>>

Performs the conversion.

impl<'lua, T> PartialEq<T> for String<'lua> where
    T: AsRef<[u8]>, 

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'lua> ToLua<'lua> for String<'lua>

fn to_lua(self, _: &'lua Lua) -> Result<Value<'lua>>

Performs the conversion.