flutter - Dart 2.1.0 smart cast using 'is' not working

Question

I'm using the Bloc pattern and have the following code to define my states:

import 'package:meta/meta.dart'

@immutable
abstract class UiState {}

class Loading extends UiState {}

class Success extends UiState {
  Success(this.message);

  final String message;
}

class Failure extends UiState {}

I try to use a UiState as follows:

class MyWidget extends StatelessWidget {
  const MyWidget({
    Key key,
    @required this.uiState,
  }) : super(key: key);

  final UiState uiState;

  Widget build(BuildContext context) {
    if (uiState is Success) {
      return Text(uiState.message);
    }
    ...
  }
}

But VSCode tells me that "The getter 'message' isn't defined for the class 'UiState'".

I've used smart casts before and they did work. But in this instance, I'm not able to figure out why it's not working.

My pubspec has the following:

environment:
  sdk: ">=2.1.0 <3.0.0"

So, I assume my dart version is atleast 2.1.0.

Answer 1

is performs implicit type promotion only for local variables.

For a local variable, the compiler can deduce that the type of the local variable will not be change between the time that its type is checked with is and before the variable is used.

For a non-local variable, the compiler cannot easily make that guarantee. Non-local variables implicitly provide getter functions, which could be overridden by derived class and which could return different values from one access to the next.

Also see:

• https://github.com/dart-lang/sdk/issues/21530
• https://github.com/dart-lang/sdk/issues/34480

As an alternative to an explicit cast, you of course could store the non-local variable in a local variable first. For example:

void memberFun() {
  final emp = _emp;
  if (emp is Person) {
    emp.firstName = 'Bob';
  }
}

Also see https://dart.dev/tools/non-promotion-reasons for some other reasons why automatic type promotion might not occur.