Skip to main content

StringExpression

Struct StringExpression 

Source
pub struct StringExpression { /* private fields */ }
Expand description

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§

Source§

impl StringExpression

Source

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();
Source

pub fn empty() -> Self

Creates an empty string expression.

Source

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

Creates a new StringExpression from a string value.

Source

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

Attaches a token to this string expression.

Source

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

Sets the token for this string expression.

Source

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

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

Source

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

Returns the string value.

Source

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

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

Source

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

Consumes the string expression and returns the inner string value.

Source

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

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

Source

pub fn is_multiline(&self) -> bool

Checks if the string contains newline characters.

Source

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.

Source

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.

Source

pub fn clear_comments(&mut self)

Clears all comments from the tokens in this node.

Source

pub fn clear_whitespaces(&mut self)

Clears all whitespaces information from the tokens in this node.

Trait Implementations§

Source§

impl Clone for StringExpression

Source§

fn clone(&self) -> StringExpression

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StringExpression

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for StringExpression

Source§

impl From<StringExpression> for Arguments

Source§

fn from(string: StringExpression) -> Self

Converts to this type from the input type.
Source§

impl From<StringExpression> for AttributeArguments

Source§

fn from(v: StringExpression) -> Self

Converts to this type from the input type.
Source§

impl From<StringExpression> for Expression

Source§

fn from(string: StringExpression) -> Self

Converts to this type from the input type.
Source§

impl From<StringExpression> for LiteralExpression

Source§

fn from(v: StringExpression) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for StringExpression

Source§

fn eq(&self, other: &StringExpression) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for StringExpression

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.