Docs4dev
Docs
dart / 2 / dart-core / runes-class.html

dart:core

Runes class

The runes (integer Unicode code points) of a String.

The characters of a string are encoded in UTF-16. Decoding UTF-16, which combines surrogate pairs, yields Unicode code points. Following a similar terminology to Go, Dart uses the name 'rune' for an integer representing a Unicode code point. Use the runes property to get the runes of a string.

Example:

const string = 'Dart';
final runes = string.runes.toList();
print(runes); // [68, 97, 114, 116]

For a character outside the Basic Multilingual Plane (plane 0) that is composed of a surrogate pair, runes combines the pair and returns a single integer.

For example, the Unicode character for "Man" emoji ('๐Ÿ‘จ', U+1F468) is combined from the surrogates U+d83d and U+dc68.

Example:

const emojiMan = '๐Ÿ‘จ';
print(emojiMan.runes); // (128104)

// Surrogate pairs:
for (final item in emojiMan.codeUnits) {
  print(item.toRadixString(16));
  // d83d
  // dc68
}

See also:

Inheritance
Available Extensions

Constructors

Runes(String string)
Creates a Runes iterator for string.

Properties

first โ†’ int
read-only, inherited
Returns the first element.
hashCode โ†’ int
read-only, inherited
The hash code for this object.
isEmpty โ†’ bool
read-only, inherited
Whether this collection has no elements.
isNotEmpty โ†’ bool
read-only, inherited
Whether this collection has at least one element.
iterator โ†’ RuneIterator
read-only, override
Returns a new Iterator that allows iterating the elements of this Iterable.
last โ†’ int
read-only, override
Returns the last element.
length โ†’ int
read-only, inherited
Returns the number of elements in this.
runtimeType โ†’ Type
read-only, inherited
A representation of the runtime type of the object.
single โ†’ int
read-only, inherited
Checks that this iterable has only one element, and returns that element.
string โ†’ String
final
The string that this is the runes of.

Methods

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

Operators

operator ==(Object other) โ†’ bool
inherited
The equality operator.

ยฉ 2012 the Dart project authors
Licensed under the BSD 3-Clause "New" or "Revised" License.
https://api.dart.dev/stable/2.18.5/dart-core/Runes-class.html