Struct mlua::String

pub struct String<'lua>(_);

Handle to an internal Lua string.

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

Implementations

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 to_string_lossy(&self) -> Cow<'_, str>

Converts this string to a Cow<str>.

Any non-Unicode sequences are replaced with U+FFFD REPLACEMENT CHARACTER.

Examples

let lua = Lua::new();

let s = lua.create_string(b"test\xff")?;
assert_eq!(s.to_string_lossy(), "test\u{fffd}");

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.

pub fn to_pointer(&self) -> *const c_void

Converts the string to a generic C pointer.

There is no way to convert the pointer back to its original value.

Typically this function is used only for hashing and debug information.

Trait Implementations

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

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

Converts this type into a shared reference of the (usually inferred) input type.

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

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

Immutably borrows from an owned value.

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

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

Returns a copy of the value.

const 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> Hash for String<'lua>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

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 ==.

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

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

impl<'lua> Serialize for String<'lua>

fn serialize<S>(&self, serializer: S) -> StdResult<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

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

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

Performs the conversion.

impl<'lua> Eq for String<'lua>