Struct rlua::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>

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

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

Examples

let lua = Lua::new();
let globals = lua.globals();

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

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

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

Get the bytes that make up this string.

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

Examples

let lua = Lua::new();

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

Trait Implementations

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, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

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

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

Performs the conversion.

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

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

Performs the conversion.