mrdocs::lua::String

A Lua string.

Synopsis

Declared in <mrdocs/Support/Lua.hpp>

class String
    : public Value

Base Classes

Name Description

Value

A Lua value.

Member Functions

Name

Description

String [constructor]

Constructors

call

Invoke the value as a function.

displayString

Return a string representation.

get

Retrieve the underlying string view.

isBoolean

Return true if the value is a boolean.

isFunction

Return true if the value is a function.

isNil

Return true if the value is nil.

isNumber

Return true if the value is numeric.

isString

Return true if the value is a string.

isTable

Return true if the value is a table.

operator()

Invoke the value as a function.

operator*

Dereference to the underlying string view.

type

Return the Lua type of this value.

operator std::string_view

Implicit conversion to string view.

Protected Data Members

Name

Description

index_

Stack index where the value is stored.

scope_

Scope that owns the stack slot for this value.

Friends

Name Description

mrdocs::lua::Access

Internal tag granting access to lua internals.

Created with MrDocs