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

Interface Formattable

Provides the format function, which allows objects to be formatted according to a format string. The format string's meaning is defined by the object being formatted.

Format strings may be provided to formattable objects during string interpolation, using the syntax "\{value:format}". For instance,

def value := 255
Console.printLine("\{value} in hexadecimal is: \{value:X}")

This calls value.format("X"), which is understood by the Int64 class to mean "format this number in uppercase hexadecimal". This results in the output:

255 in hexadecimal is: FF

and is equivalent to having written:

Console.printLine(value + " in hexadecimal is: " + value.format("X"))

Source Code:: View Source

Inherited Fields:

Instance Method Summary

format(fmt:String):String

Instance Methods


function format

(fmt:String
):String

Parameters:: fmt - value of type String