kotlin-metadata-jvm/kotlin.metadata/returnValueStatus

returnValueStatus

@ExperimentalMustUseStatus
var KmConstructor.returnValueStatus: ReturnValueStatus

Indicates whether the constructor was compiled with return value status information. This status may come from @MustUseReturnValues annotation on one of the containing scopes, or from -Xreturn-value-checker=full global compilation setting. See ReturnValueStatus for details.

Constructors cannot have ReturnValueStatus.EXPLICITLY_IGNORABLE status. Setting it as KmConstructor.returnValueStatus will result in an undefined behavior.

See also

@ExperimentalMustUseStatus
var KmFunction.returnValueStatus: ReturnValueStatus

Indicates whether the function was compiled with return value status information. This status may come from @MustUseReturnValues annotation on one of the containing scopes, or from -Xreturn-value-checker=full global compilation setting. See ReturnValueStatus for details.

See also

@ExperimentalMustUseStatus
var KmProperty.returnValueStatus: ReturnValueStatus

Indicates whether the property was compiled with return value status information. This status may come from @MustUseReturnValues annotation on one of the containing scopes, or from -Xreturn-value-checker=full global compilation setting. See ReturnValueStatus for details.

While @IgnorableReturnValue annotation is not applicable to properties, they still can have ReturnValueStatus.EXPLICITLY_IGNORABLE status in case this property overrides a Java callable with annotation applied.

See also