Home
Getting Started
Current Status
Documentation
- frostc
- Syntax
  - Keywords
  - Statements
    - Assignment
    - Method Calls
    - if
    - for
    - while
    - do
    - loop
    - break
    - continue
    - return
    - assert
    - unreachable
    - match
    - try
  - Expressions
  - Annotations
  - Comments
  - Documentation Comments
  - Error Handling
- Classes
  - Interfaces
  - Choices
  - Values
  - Immutability
  - Packages
    - Uses
  - Generics
  - Bare Code
- Methods
- Fields
- Types
- Variables and Constants
- Memory
  - Weak References
- Threads
API Documentation
- frostcollections Array Collection CollectionView CollectionWriter DefaultHashMap HashKey HashMap HashSet IdentityMap IdentitySet ImmutableArray Iterable Iterator List ListView ListWriter Map MapView MapWriter Stack core Bit Char16 Char32 Char8 Comparable Equatable Error Formattable Immutable Int Int16 Int32 Int64 Int8 Matcher Maybe MutableString Index MutableValue Object Range Real32 Real64 RegularExpression SteppedRange String Index Match System Process UInt UInt16 UInt32 UInt64 UInt8 Value Weak io ByteOrder Console File IndentedOutputStream InputStream LineNumberInputStream MemoryInputStream MemoryOutputStream OutputStream PushbackInputStream math Random XorShift128Plus threads Lock MessageQueue Notifier ScopedLock Thread time Timer unsafe Pointer UnsafeMessageQueue

frost.core

Class Char16

└ Value

└ Immutable

└ Object

Implemented Interfaces:

HashKey<Char16>, Comparable<Char16>

Represents a single 2-byte word of a UTF-16 encoded string.

A single-codepoint string literal whose single codepoint fits into a Char16 (that is, Unicode codepoints 0 to 65535) may be used wherever a Char16 is expected. That is, it is legal to write:

def c:Char16 := "A"

Source Code:: View Source

Class Method Summary

-- multiply operator -- *(count:Int, char:Char16):String: Returns a string consisting of count copies of the given character.

Initializer Summary

init(value:UInt16):Char16: Creates a Char16 with the specified codepoint.

Field Summary

isWhitespace:Bit: true if this character is whitespace.
isDigit:Bit: true if this character is a numeric digit.
asChar8:Char8: This character converted to a Char8.
asChar32:Char32: This character converted to a Char32.
asInt8:Int8: This character's codepoint converted to an 8 bit signed number.
asInt16:Int16: This character's codepoint converted to a 16 bit signed number.
asInt32:Int32: This character's codepoint converted to a 32 bit signed number.
asInt64:Int64: This character's codepoint converted to a 64 bit signed number.
asInt:Int: This character's codepoint converted to an Int.
asUInt8:UInt8: This character's codepoint converted to an 8 bit unsigned number.
asUInt16:UInt16: This character's codepoint converted to a 16 bit unsigned number.
asUInt32:UInt32: This character's codepoint converted to a 32 bit unsigned number.
asUInt64:UInt64: This character's codepoint converted to a 64 bit unsigned number.
asUInt:UInt: This character's codepoint converted to a UInt.
toChar8:Char8: This character converted to a Char8.
toChar32:Char32: This character converted to a Char32.
toInt8:Int8: This character's codepoint converted to an 8 bit signed number.
toInt16:Int16: This character's codepoint converted to a 16 bit signed number.
toInt32:Int32: This character's codepoint converted to a 32 bit signed number.
toInt64:Int64: This character's codepoint converted to a 64 bit signed number.
toInt:Int: This character's codepoint converted to an Int.
toUInt8:UInt8: This character's codepoint converted to an 8 bit unsigned number.
toUInt16:UInt16: This character's codepoint converted to a 16 bit unsigned number.
toUInt32:UInt32: This character's codepoint converted to a 32 bit unsigned number.
toUInt64:UInt64: This character's codepoint converted to a 64 bit unsigned number.
toUInt:UInt: This character's codepoint converted to a UInt.

Inherited Fields:

toString

Instance Method Summary

-- subtract operator -- -(other:Char16):UInt16: Returns the difference between the codepoints of two Char16s.
-- subtract operator -- -(other:Char16):Int: Returns the difference between the codepoints of two Char16s.
-- equals operator -- =(other:Char16):Bit: Returns true if these objects are equal.
-- not equal operator -- !=(other:Char16):Bit: Returns true if these objects are not equal.
-- less than operator -- <(other:Char16):Bit
-- greater than operator -- >(other:Char16):Bit
-- less than or equal operator -- <=(other:Char16):Bit
-- greater than or equal operator -- >=(other:Char16):Bit
-- multiply operator -- *(count:Int):String: Returns a string consisting of count copies of this character.

Initializers


init
(value:UInt16
):Char16

Creates a Char16 with the specified codepoint.

Parameters:: value - value of type UInt16

Fields

property isWhitespace:Bit

true if this character is whitespace.

property isDigit:Bit

true if this character is a numeric digit.

property asChar8:Char8

This character converted to a Char8. If this number is not in the range of a Char8, a safety violation occurs.

property asChar32:Char32

This character converted to a Char32.

property asInt8:Int8

This character's codepoint converted to an 8 bit signed number. If this number is not in the range of an 8 bit signed number, a safety violation occurs.

property asInt16:Int16

This character's codepoint converted to a 16 bit signed number. If this number is not in the range of a 16 bit signed number, a safety violation occurs.

property asInt32:Int32

This character's codepoint converted to a 32 bit signed number.

property asInt64:Int64

This character's codepoint converted to a 64 bit signed number.

property asInt:Int

This character's codepoint converted to an Int.

property asUInt8:UInt8

This character's codepoint converted to an 8 bit unsigned number. If this number is not in the range of an 8 bit unsigned number, a safety violation occurs.

property asUInt16:UInt16

This character's codepoint converted to a 16 bit unsigned number.

property asUInt32:UInt32

This character's codepoint converted to a 32 bit unsigned number.

property asUInt64:UInt64

This character's codepoint converted to a 64 bit unsigned number.

property asUInt:UInt

This character's codepoint converted to a UInt.

property toChar8:Char8

This character converted to a Char8. If the character's codepoint does not fit into a Char8, it will silently overflow.

property toChar32:Char32

This character converted to a Char32.

property toInt8:Int8

This character's codepoint converted to an 8 bit signed number. If the character's codepoint does not fit into an 8 bit signed number, it will silently overflow.

property toInt16:Int16

This character's codepoint converted to a 16 bit signed number. If the character's codepoint does not fit into a 16 bit signed number, it will silently overflow.

property toInt32:Int32

This character's codepoint converted to a 32 bit signed number.

property toInt64:Int64

This character's codepoint converted to a 64 bit signed number.

property toInt:Int

This character's codepoint converted to an Int.

property toUInt8:UInt8

This character's codepoint converted to an 8 bit unsigned number. If the character's codepoint does not fit into an 8 bit unsigned number, it will silently overflow.

property toUInt16:UInt16

This character's codepoint converted to a 16 bit unsigned number.

property toUInt32:UInt32

This character's codepoint converted to a 32 bit unsigned number.

property toUInt64:UInt64

This character's codepoint converted to a 64 bit unsigned number.

property toUInt:UInt

This character's codepoint converted to a UInt.

Class Methods

-- multiply operator --
@class

function *

(count:Int,
 char:Char16
):String

Returns a string consisting of count copies of the given character.

Parameters:: count - value of type Int
char - value of type Char16

Instance Methods

-- subtract operator --

function -

(other:Char16
):UInt16

Returns the difference between the codepoints of two Char16s.

Parameters:: other - value of type Char16

-- subtract operator --

function -

(other:Char16
):Int

Returns the difference between the codepoints of two Char16s.

Parameters:: other - value of type Char16

-- equals operator --
@override

function =

(other:Char16
):Bit

Returns true if these objects are equal.

Parameters:: other - value of type Char16

Overrides:: frost.core.Equatable.=

-- not equal operator --
@override

function !=

(other:Char16
):Bit

Returns true if these objects are not equal.

Parameters:: other - value of type Char16

Overrides:: frost.core.Equatable.!=

-- less than operator --
@override

function <

(other:Char16
):Bit

Parameters:: other - value of type Char16

-- greater than operator --
@override

function >

(other:Char16
):Bit

Parameters:: other - value of type Char16

-- less than or equal operator --
@override

function <=

(other:Char16
):Bit

Parameters:: other - value of type Char16

-- greater than or equal operator --
@override

function >=

(other:Char16
):Bit

Parameters:: other - value of type Char16

-- multiply operator --

function *

(count:Int
):String

Returns a string consisting of count copies of this character.

Parameters:: count - value of type Int