Naming enum

/ Configuration options and utilities for naming and renaming signals.

Inheritance

Constructors

Naming()
const

Values

reserved → const Naming

The signal will be present in generated output and the name will not be changed.

If this is not achievable, an Exception will be thrown.

renameable → const Naming

The signal will be present in generated output, but the signal may be renamed for uniqueness. It will not be merged into any other signals.

mergeable → const Naming

The signal may be merged with other equivalent signals in generated outputs, and any of the names from the merged signals may be selected.

unnamed → const Naming

This signal has no given name and generated output will attempt to name it as best as it can.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

chooseName(String? name, Naming? naming, {String nullStarter = 's'}) → String
Picks a String name based on an initial name and naming.
chooseNaming(String? name, Naming? naming) → Naming
Picks a Naming based on an initial name and naming.
isUnpreferred(String name) → bool
Returns true iff the signal name is "unpreferred".
unpreferredName(String name) → String
Makes a signal name "unpreferred" when considering between multiple possible signal names.
validatedName(String? name, {required bool reserveName}) → String?
Returns name if it meets requirements for the specified reserveName, otherwise throws an Exception.

Constants

values → const List<Naming>
A constant List of the values in this enum, in order of their declaration.