Struct String 

pub struct String(pub(crate) ValueRef);

Handle to an internal Lua string.

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

Tuple Fields

0: ValueRef

Implementations

impl String

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

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) -> String

Converts this string to a StdString.

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

This method returns StdString instead of Cow<'_, str> because lifetime cannot be bound to a weak Lua object.

Examples

let lua = Lua::new();

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

pub fn display(&self) -> impl Display

Returns an object that implements Display for safely printing a Lua String that may contain non-Unicode data.

This may perform lossy conversion.

pub fn as_bytes(&self) -> BorrowedBytes<'_>

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

impl String

pub fn wrap(data: impl AsRef<[u8]>) -> impl IntoLua

Wraps bytes, returning an opaque type that implements IntoLua trait.

This function uses Lua::create_string under the hood.

Trait Implementations

impl Clone for String

fn clone(&self) -> String

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl<'a> From<&'a String> for BorrowedBytes<'a>

fn from(value: &'a String) -> BorrowedBytes<'a>

Converts to this type from the input type.

impl FromLua for String

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

Performs the conversion.

impl Hash for String

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

where H: Hasher,

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, Error>

Performs the conversion.

impl IntoLua for String

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

Performs the conversion.

impl Ord for String

fn cmp(&self, other: &String) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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<T> PartialOrd<T> for String

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

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd for String

fn partial_cmp(&self, other: &String) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> TryFrom<&'a String> for BorrowedStr<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a String) -> Result<BorrowedStr<'a>, Error>

Performs the conversion.

impl Eq for String