Digits class final

An immutable, iterable sequence of decimal digits, each a Digit (0-9).

A digits-only identifier (a bank account number, a national phone number, a SKU) modelled as digits rather than a raw String, so letters and other junk are unrepresentable. It is validated once on construction; after that you iterate it, index it, or read asString, without re-checking.

Backed by a Uint8List (one byte per digit, a real Uint8Array on the web), kept private so a denser packing can replace it behind this same interface. Equality is by value over the digits.

Inheritance
Annotations
  • @immutable

Properties

asString String
The digits as a plain string, e.g. '12345' (the canonical form).
no setter
first Digit
The first element.
no setterinherited
hashCode int
The hash code for this object.
no setteroverride
isEmpty bool
Whether this collection has no elements.
no setterinherited
isNotEmpty bool
Whether this collection has at least one element.
no setterinherited
iterator Iterator<Digit>
A new Iterator that allows iterating the elements of this Iterable.
no setteroverride
last Digit
The last element.
no setterinherited
length int
The number of elements in this Iterable.
no setteroverride
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
single Digit
Checks that this iterable has only one element, and returns that element.
no setterinherited

Methods

any(bool test(Digit element)) bool
Checks whether any element of this iterable satisfies test.
inherited
cast<R>() Iterable<R>
A view of this iterable as an iterable of R instances.
inherited
contains(Object? element) bool
Whether the collection contains an element equal to element.
inherited
elementAt(int index) Digit
Returns the indexth element.
inherited
every(bool test(Digit element)) bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> toElements(Digit element)) Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
firstWhere(bool test(Digit element), {Digit orElse()?}) Digit
The first element that satisfies the given predicate test.
inherited
fold<T>(T initialValue, T combine(T previousValue, Digit element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<Digit> other) Iterable<Digit>
Creates the lazy concatenation of this iterable and other.
inherited
forEach(void action(Digit element)) → void
Invokes action on each element of this iterable in iteration order.
inherited
join([String separator = ""]) String
Converts each element to a String and concatenates the strings.
inherited
lastWhere(bool test(Digit element), {Digit orElse()?}) Digit
The last element that satisfies the given predicate test.
inherited
map<T>(T toElement(Digit e)) Iterable<T>
The current elements of this iterable modified by toElement.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reduce(Digit combine(Digit value, Digit element)) Digit
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
singleWhere(bool test(Digit element), {Digit orElse()?}) Digit
The single element that satisfies test.
inherited
skip(int count) Iterable<Digit>
Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(Digit element)) Iterable<Digit>
Creates an Iterable that skips leading elements while test is satisfied.
inherited
take(int count) Iterable<Digit>
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(Digit element)) Iterable<Digit>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) List<Digit>
Creates a List containing the elements of this Iterable.
inherited
toSet() Set<Digit>
Creates a Set containing the same elements as this iterable.
inherited
toString() String
Returns a string representation of (some of) the elements of this.
override
where(bool test(Digit element)) Iterable<Digit>
Creates a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<T>() Iterable<R>
Creates a new lazy Iterable with all elements that have type T.
inherited

Operators

operator ==(Object other) bool
The equality operator.
override
operator [](int index) Digit
The Digit at index (0-based).

Static Methods

of(Iterable<Digit> digits) Digits
The sequence built from the given digits, minted directly: each is already 0-9.
tryFrom(List<int> values) Digits?
The sequence of the given values, or null unless every value is in 0-9.