GetItBinder#

Binder implementation backed by two separate GetIt instances (private and public scopes), designed for integration with the injectable package.

Manages two isolated GetIt containers: one for private module registrations and another for publicly exported dependencies. Tracks registered types manually to support ExportableBinder semantics.

Resolution Order#

When get or tryGet is called, lookup proceeds as:

1. Private GetIt scope.
2. Public GetIt scope.
3. Imported binders (public exports only).
4. Parent binder (if any).

Note: A different class also named GetItBinder exists in the modularity_get_it standalone adapter package. That variant uses a single scoped GetIt instance with RegistrationAwareBinder support. Choose the implementation that matches your integration needs.

See also:

• GetItBinderFactory which produces these binders.
• ModularityInjectableBridge for wiring injectable init functions.

Constructors#

GetItBinder()#

Create a binder with optional imports and parent scope.

Each instance gets its own private and public GetIt containers.

GetItBinder({List<Binder> imports = const [], Binder? parent})
  : _privateScope = GetIt.asNewInstance(),
    _publicScope = GetIt.asNewInstance(),
    _imports = imports.toList(),
    _parent = parent {
  &#47;&#47; Allow reassignment for hot reload support
  _publicScope.allowReassignment = true;
}

Properties#

hashCode no setter inherited#

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

external int get hashCode;

internalContainer no setter#

Exposes the scoped container used for private registrations.

GetIt get internalContainer => _privateScope;

isExportModeEnabled no setter#

@override
bool get isExportModeEnabled => _isExportMode;

isPublicScopeSealed no setter#

@override
bool get isPublicScopeSealed => _publicSealed;

publicContainer no setter#

Exposes the scoped container storing exported dependencies.

GetIt get publicContainer => _publicScope;

runtimeType no setter inherited#

A representation of the runtime type of the object.

Inherited from Object.

external Type get runtimeType;

Methods#

addImports()#

@override
void addImports(List<Binder> binders) {
  _imports.addAll(binders);
}

contains()#

@override
bool contains(Type type) {
  if (_privateTypes.contains(type) || _publicTypes.contains(type)) {
    return true;
  }

  for (final imported in _imports) {
    final contains = imported is ExportableBinder
        ? imported.containsPublic(type)
        : imported.contains(type);
    if (contains) return true;
  }

  if (_parent?.contains(type) == true) {
    return true;
  }

  return false;
}

containsPublic()#

@override
bool containsPublic(Type type) => _publicTypes.contains(type);

debugGraph()#

Text dump describing current registrations.

String debugGraph({bool includeImports = false}) {
  String renderTypes(Set<Type> types) {
    if (types.isEmpty) return '    <empty>';
    return types.map((t) => '    - ${t.toString()}').join('\n');
  }

  final buffer = StringBuffer()
    ..writeln('GetItBinder(${hashCode.toRadixString(16)})')
    ..writeln('  Private:')
    ..writeln(renderTypes(_privateTypes))
    ..writeln('  Public:')
    ..writeln(renderTypes(_publicTypes));

  if (includeImports && _imports.isNotEmpty) {
    buffer.writeln('  Imports:');
    for (final imported in _imports) {
      if (imported is GetItBinder) {
        final nested = imported
            .debugGraph(includeImports: false)
            .split('\n')
            .map((line) => '    $line')
            .join('\n');
        buffer.writeln(nested);
      } else {
        buffer.writeln('    - ${imported.runtimeType}');
      }
    }
  }

  return buffer.toString();
}

disableExportMode()#

@override
void disableExportMode() => _isExportMode = false;

dispose()#

Dispose both GetIt scopes and clear internal state.

@override
Future<void> dispose() async {
  _publicTypes.clear();
  _publicDisposers.clear();
  _publicSealed = false;
  _privateTypes.clear();
  _privateDisposers.clear();
  &#47;&#47; Reset both scopes
  await _privateScope.reset(dispose: true);
  await _publicScope.reset(dispose: true);
}

enableExportMode()#

@override
void enableExportMode() => _isExportMode = true;

get()#

@override
T get<T extends Object>() {
  final value = tryGet<T>();
  if (value != null) return value;
  throw DependencyNotFoundException(
    'Dependency of type $T not found in current scope.',
    requestedType: T,
    availableTypes: [..._privateTypes, ..._publicTypes],
  );
}

noSuchMethod() inherited#

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

parent()#

@override
T parent<T extends Object>() {
  final value = tryParent<T>();
  if (value != null) {
    return value;
  }
  throw DependencyNotFoundException(
    'Dependency of type $T not found in parent scope.',
    requestedType: T,
    lookupContext: 'parent scope',
  );
}

registerFactory()#

@override
void registerFactory<T extends Object>(T Function() factory) {
  _register<T>((scope) => scope.registerFactory<T>(factory));
}

registerLazySingleton()#

@override
void registerLazySingleton<T extends Object>(T Function() factory) {
  _register<T>((scope) => scope.registerLazySingleton<T>(factory));
}

registerSingleton()#

@override
void registerSingleton<T extends Object>(T instance) {
  _register<T>((scope) => scope.registerSingleton<T>(instance));
}

resetPublicScope()#

@override
void resetPublicScope() {
  // Clear tracking sets - allowReassignment handles re-registration
  _publicTypes.clear();
  _publicDisposers.clear();
  _publicSealed = false;
}

sealPublicScope()#

@override
void sealPublicScope() {
  _publicSealed = true;
}

toString() inherited#

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.

Inherited from Object.

external String toString();

tryGet()#

@override
T? tryGet<T extends Object>() {
  if (_privateScope.isRegistered<T>()) {
    return _privateScope.get<T>();
  }
  if (_publicScope.isRegistered<T>()) {
    return _publicScope.get<T>();
  }

  for (final importedBinder in _imports) {
    final value = importedBinder is ExportableBinder
        ? importedBinder.tryGetPublic<T>()
        : importedBinder.tryGet<T>();
    if (value != null) {
      return value;
    }
  }

  final parentValue = _parent?.tryGet<T>();
  if (parentValue != null) {
    return parentValue;
  }

  return null;
}

tryGetPublic()#

@override
T? tryGetPublic<T extends Object>() {
  if (_publicScope.isRegistered<T>()) {
    return _publicScope.get<T>();
  }
  return null;
}

tryParent()#

@override
T? tryParent<T extends Object>() => _parent?.tryGet<T>();

Operators#

operator ==() inherited#

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

external bool operator ==(Object other);