Struct String

pub struct String(/* private fields */);

Handle to an internal Lua string.

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

Implementations

impl String

pub fn to_str(&self) -> Result<BorrowedStr<'_>>

Get a BorrowedStr 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) -> StdString

Converts this string to a StdString.

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) -> BorrowedBytes<'_>

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) -> BorrowedBytes<'_>

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

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

Converts this 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 Clone for String

fn clone(&self) -> String

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for String

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

Formats the value using the given formatter.

impl FromLua for String

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

Performs the conversion.

impl Hash for String

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoLua for &String

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

Performs the conversion.

impl IntoLua for String

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

Performs the conversion.

impl PartialEq<&String> for String

fn eq(&self, other: &&String) -> 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.

impl<T> PartialEq<T> for String

where T: AsRef<[u8]> + ?Sized,

fn eq(&self, other: &T) -> 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.

impl PartialEq for String

fn eq(&self, other: &String) -> 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.

impl Serialize for String

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for String