SavedStateKt

Added in 1.3.0-alpha02

public final class SavedStateKt

Summary

Public methods
static final @NonNull T
<T extends Object> read(
    @NonNull SavedState receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull SavedStateReader, @NonNull T> block
)

Calls the specified function block with a SavedStateReader value as its receiver and returns the block value.
static final @NonNull T
<T extends Object> read(
    @NonNull SavedStateWriter receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull SavedStateReader, @NonNull T> block
)

Calls the specified function block with a SavedStateReader value as its receiver and returns the block value.
static final @NonNull SavedStateReader

Creates a new SavedStateReader for the SavedState.
static final @NonNull SavedState

Constructs an empty SavedState instance.
static final @NonNull T
<T extends Object> write(
    @NonNull SavedState receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull SavedStateWriter, @NonNull T> block
)

Calls the specified function block with a SavedStateWriter value as its receiver and returns the block value.
static final @NonNull T
<T extends Object> write(
    @NonNull SavedStateReader receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull SavedStateWriter, @NonNull T> block
)

Calls the specified function block with a SavedStateWriter value as its receiver and returns the block value.
static final @NonNull SavedStateWriter

Creates a new SavedStateWriter for the SavedState.

Public methods

read

public static final @NonNull T <T extends Object> read(
    @NonNull SavedState receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull SavedStateReader, @NonNull T> block
)

Calls the specified function block with a SavedStateReader value as its receiver and returns the block value.

Parameters
@ExtensionFunctionType @NonNull Function1<@NonNull SavedStateReader, @NonNull T> block

A lambda function that performs read operations using the SavedStateReader.
Returns
@NonNull T

The result of the lambda function's execution.
See also
SavedStateReader
SavedStateWriter

read

public static final @NonNull T <T extends Object> read(
    @NonNull SavedStateWriter receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull SavedStateReader, @NonNull T> block
)

Calls the specified function block with a SavedStateReader value as its receiver and returns the block value.

Parameters
@ExtensionFunctionType @NonNull Function1<@NonNull SavedStateReader, @NonNull T> block

A lambda function that performs read operations using the SavedStateReader.
Returns
@NonNull T

The result of the lambda function's execution.
See also
SavedStateReader
SavedStateWriter

reader

public static final @NonNull SavedStateReader reader(@NonNull SavedState receiver)

Creates a new SavedStateReader for the SavedState.

savedState

public static final @NonNull SavedState savedState(
    @ExtensionFunctionType @NonNull Function1<@NonNull SavedStateWriter, Unit> block
)

Constructs an empty SavedState instance.

write

public static final @NonNull T <T extends Object> write(
    @NonNull SavedState receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull SavedStateWriter, @NonNull T> block
)

Calls the specified function block with a SavedStateWriter value as its receiver and returns the block value.

Parameters
@ExtensionFunctionType @NonNull Function1<@NonNull SavedStateWriter, @NonNull T> block

A lambda function that performs write operations using the SavedStateWriter.
Returns
@NonNull T

The result of the lambda function's execution.
See also
SavedStateReader
SavedStateWriter

write

public static final @NonNull T <T extends Object> write(
    @NonNull SavedStateReader receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull SavedStateWriter, @NonNull T> block
)

Calls the specified function block with a SavedStateWriter value as its receiver and returns the block value.

Parameters
@ExtensionFunctionType @NonNull Function1<@NonNull SavedStateWriter, @NonNull T> block

A lambda function that performs write operations using the SavedStateWriter.
Returns
@NonNull T

The result of the lambda function's execution.
See also
SavedStateReader
SavedStateWriter

writer

public static final @NonNull SavedStateWriter writer(@NonNull SavedState receiver)

Creates a new SavedStateWriter for the SavedState.