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

Choice Maybe<T>

Holds either a value or an Error. Maybe is intended for use as a return type for a method which returns a value, but is not always guaranteed to succeed.

Source Code:: View Source

Case Summary

SUCCESS(T): A successful call with return value.
ERROR(Error): An error occurred.

Inherited Fields:

Instance Method Summary

get():T: Returns the result of a successful call.
error():Error: Returns the error message of a failed call.
succeeded():Bit: Returns true if the call succeeded.

Cases

SUCCESS(T)

A successful call with return value.

ERROR(Error)

An error occurred.

Instance Methods

@pre(succeeded())

function get

():T

Returns the result of a successful call.

@pre(!succeeded())

function error

():Error

Returns the error message of a failed call.


function succeeded

():Bit

Returns true if the call succeeded.