Custom Datatypes​

constructor Range<T>.empty()​

Range<T>.empty()

Creates a new empty Range of type T.

constructor Range<T>()​

Range<T>(
  T? lower,
  T? upper,
  {bool? incLower,
  bool? incUpper}
)

Creates a new Range.

If not given, incLower and incUpper default to true and false respectively.

method .compareTo()​

int compareTo(
  Range<T> other
)

Compares this object to another object.

Returns a value like a Comparator when comparing this to other. That is, it returns a negative integer if this is ordered before other, a positive integer if this is ordered after other, and zero if this and other are ordered together.

The other argument must be a value that is comparable to this object.

method .contains()​

bool contains(
  T element
)

Checks whether element is within this range.

method .containsRange()​

bool containsRange(
  Range<T> range
)

Checks whether range is entirely within this range.

property .hashCode​

int get hashCode

The hash code for this object.

property .incLower​

bool get incLower

Whether the lower boundary is inclusive. Is always false for unspecified boundaries and empty ranges.

property .incUpper​

bool get incUpper

Whether the upper boundary is inclusive. Is always false for unspecified boundaries and empty ranges.

property .isEmpty​

bool get isEmpty

Whether the range is empty.

property .lower​

T? get lower

The lower boundary of the range, if it exists.

operator ==​

bool operator ==(
  Object other
)

Returns whether two ranges are equal.

operator >​

bool operator >(
  Range<T> other
)

Returns whether this range is after the other range.

A range is considered to be ordered after another range if its lower bound is greater than the other. If the lower bounds are equal, the upper bounds are checked. An empty range is considered lower than a non-empty range, and unspecified lower/upper bounds are considered lower/greater than specified lower/upper bounds respectively.

operator >=​

bool operator >=(
  Range<T> other
)

Returns whether this range is after or equal to the other range.

A range is considered to be ordered after another range if its lower bound is greater than the other. If the lower bounds are equal, the upper bounds are checked. An empty range is considered lower than a non-empty range, and unspecified lower/upper bounds are considered lower/greater than specified lower/upper bounds respectively.

operator <​

bool operator <(
  Range<T> other
)

Returns whether this range is before the other range.

A range is considered to be ordered before another range if its lower bound is lower than the other. If the lower bounds are equal, the upper bounds are checked. An empty range is considered lower than a non-empty range, and unspecified lower/upper bounds are considered lower/greater than specified lower/upper bounds respectively.

operator <=​

bool operator <=(
  Range<T> other
)

Returns whether this range is before or equal to the other range.

A range is considered to be ordered before another range if its lower bound is lower than the other. If the lower bounds are equal, the upper bounds are checked. An empty range is considered lower than a non-empty range, and unspecified lower/upper bounds are considered lower/greater than specified lower/upper bounds respectively.

operator -​

Range<T> operator -(
  Range<T> other
)

Subtracts one range from another.

Throws an error if the result is not a single continuous range.

operator \*​

Range<T> operator *(
  Range<T> other
)

Returns the intersection of two ranges.

operator +​

Range<T> operator +(
  Range<T> other
)

Returns the union of two ranges.

Throws an error if the result is not a single continuous range.

method .overlaps()​

bool overlaps(
  Range<T> other
)

Checks whether other range overlaps this range.

method .toJSON()​

dynamic toJSON()

method .toString()​

String toString()

String representation of the range.

Inclusive boundaries are denoted by [] brackets, and exclusive boundaries by (). If the range is empty, returns the string 'empty'.

method .unpack()​

Iterable<T> unpack(
  {Object? step}
)

If the range is discrete and no step is provided, returns an Iterable of all values in the range. Otherwise returns an Iterable of each value starting at the lower bound, increasing by step up to the upper bound.

An error is thrown if the range is unbounded (ie. either lower or upper are null), or the step parameter is not given for non-discrete ranges.

property .upper​

T? get upper

The upper boundary of the range, if it exists.

constructor ConfigMemory()​

ConfigMemory(
  int _bytes
)

constructor ConfigMemory.parse()​

ConfigMemory.parse(
  String mem
)

property .bytes​

int get bytes

property .gibibytes​

num get gibibytes

property .kibibytes​

num get kibibytes

property .mebibytes​

num get mebibytes

property .pebibytes​

num get pebibytes

property .tebibytes​

num get tebibytes

method .toString()​

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.