API Host StringValue

StringValue

Immutable script string wrapper.

Namespace: AuroraScript.Runtime.Types. Kind: class.

Back to .NET Host API Reference

Overview

Immutable script string wrapper.

Quick Reference

A minimal use of StringValue.

var text = StringValue.Of("Aurora");

Console.WriteLine(text.Value); // Aurora

Constructors

StringValue(string str)

Creates a StringValue instance.

StringValue(string str)

Parameters

Name	Type	Required	Description
str	string	Yes	Initial string or character.

Returns

A new StringValue instance.

StringValue(char str)

Creates a StringValue instance.

StringValue(char str)

Parameters

Name	Type	Required	Description
str	char	Yes	Initial string or character.

Returns

A new StringValue instance.

Properties

Value

string Value

Parameters

None.

Returns

Returns string.

Methods

Of

static StringValue Of(string value)

Parameters

Name	Type	Required	Description
value	string	Yes	CLR string to wrap or intern.

Returns

Returns StringValue.

Intern

static StringValue Intern(string value)

Parameters

Name	Type	Required	Description
value	string	Yes	CLR string to wrap or intern.

Returns

Returns StringValue.

IsTrue

bool IsTrue()

Parameters

None.

Returns

Returns bool.