Struct StringExpression 

pub struct StringExpression { /* private fields */ }

Represents a string literal in Lua source code.

String literals in Lua can be written with single quotes, double quotes, or with long brackets ([[...]] or [=[...]=] etc.) for multi-line strings.

Implementations

impl StringExpression

pub fn new(string: &str) -> Result<Self, StringError>

Creates a new StringExpression from a raw Lua string literal.

Handles quoted strings (with either ’ or “ delimiters), long bracket strings, and processes escape sequences in quoted strings.

let single_quoted = StringExpression::new("'hello'").unwrap();
let double_quoted = StringExpression::new("\"world\"").unwrap();
let bracket_string = StringExpression::new("[[multi\nline]]").unwrap();

pub fn empty() -> Self

Creates an empty string expression.

pub fn from_value(value: impl IntoLuaStringValue) -> Self

Creates a new StringExpression from a string value.

pub fn with_token(self, token: Token) -> Self

Attaches a token to this string expression.

pub fn set_token(&mut self, token: Token)

Sets the token for this string expression.

pub fn get_token(&self) -> Option<&Token>

Returns the token associated with this string expression, if any.

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

Returns the string value.

pub fn get_string_value(&self) -> Option<&str>

Returns the string value if it is valid UTF-8.

pub fn into_value(self) -> Vec<u8>

Consumes the string expression and returns the inner string value.

pub fn into_string(self) -> Option<String>

Consumes the string expression and returns the inner string value if it is valid UTF-8.

pub fn is_multiline(&self) -> bool

Checks if the string contains newline characters.

pub fn has_single_quote(&self) -> bool

Checks if the string contains single quotes.

Useful when determining the best quote style to use when serializing the string.

pub fn has_double_quote(&self) -> bool

Checks if the string contains double quotes.

Useful when determining the best quote style to use when serializing the string.

pub fn clear_comments(&mut self)

Clears all comments from the tokens in this node.

pub fn clear_whitespaces(&mut self)

Clears all whitespaces information from the tokens in this node.

Trait Implementations

impl Clone for StringExpression

fn clone(&self) -> StringExpression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StringExpression

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

Formats the value using the given formatter.

impl From<StringExpression> for Arguments

fn from(string: StringExpression) -> Self

Converts to this type from the input type.

impl From<StringExpression> for Expression

fn from(string: StringExpression) -> Self

Converts to this type from the input type.

impl PartialEq for StringExpression

fn eq(&self, other: &StringExpression) -> 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 Eq for StringExpression

impl StructuralPartialEq for StringExpression