micro_utils.dokka/dev.inmo.micro_utils.repos.mappers/MapperWriteCRUDRepo

MapperWriteCRUDRepo

open class MapperWriteCRUDRepo<FromId, FromRegistered, FromInput, ToId, ToRegistered, ToInput>(to: WriteCRUDRepo<ToRegistered, ToId, ToInput>, mapper: MapperRepo<FromId, FromRegistered, ToId, ToRegistered>, inputMapper: SimpleSuspendableMapper<FromInput, ToInput>) : WriteCRUDRepo<FromRegistered, FromId, FromInput> , MapperRepo<FromId, FromRegistered, ToId, ToRegistered> , SimpleSuspendableMapper<FromInput, ToInput> (source)

A WriteCRUDRepo wrapper that maps between different key, value, and input types. Allows adapting a repository to work with different type systems for both reading and writing.

Parameters

The underlying repository to wrap

mapper

The mapper for keys and values

inputMapper

The mapper for input types

Type Parameters

FromId

The external ID type

FromRegistered

The external object type for read operations

FromInput

The external input type for write operations

ToId

The internal ID type

ToRegistered

The internal object type for read operations

ToInput

The internal input type for write operations

Constructors

MapperWriteCRUDRepo

constructor(to: WriteCRUDRepo<ToRegistered, ToId, ToInput>, mapper: MapperRepo<FromId, FromRegistered, ToId, ToRegistered>, inputMapper: SimpleSuspendableMapper<FromInput, ToInput>)

Properties

deletedObjectsIdsFlow

open override val deletedObjectsIdsFlow: Flow<FromId>

Flow that emits the ID of each deleted object after a successful deleteById call.

keyMapper

open override val keyMapper: SimpleSuspendableMapper<FromId, ToId>

Provides a mapper for converting keys between inner and outer types.

newObjectsFlow

open override val newObjectsFlow: Flow<FromRegistered>

Flow that emits each newly created object after a successful create call.

onDeletedObjectsIds

val <IdType> WriteCRUDRepo<*, IdType, *>.onDeletedObjectsIds: Flow<IdType>

Mirrors WriteCRUDRepo.deletedObjectsIdsFlow under the name onDeletedObjectsIds for consistency with KV repos naming.

onNewObjects

val <ObjectType> WriteCRUDRepo<ObjectType, *, *>.onNewObjects: Flow<ObjectType>

Mirrors WriteCRUDRepo.newObjectsFlow under the name onNewObjects for consistency with KV repos naming.

onUpdatedObjects

val <ObjectType> WriteCRUDRepo<ObjectType, *, *>.onUpdatedObjects: Flow<ObjectType>

Mirrors WriteCRUDRepo.updatedObjectsFlow under the name onUpdatedObjects for consistency with KV repos naming.

updatedObjectsFlow

open override val updatedObjectsFlow: Flow<FromRegistered>

Flow that emits each updated object after a successful update call.

valueMapper

open override val valueMapper: SimpleSuspendableMapper<FromRegistered, ToRegistered>

Provides a mapper for converting values between inner and outer types.

Functions

caching

fun <ObjectType, IdType, InputType> WriteCRUDRepo<ObjectType, IdType, InputType>.caching(kvCache: KVCache<IdType, ObjectType>, scope: CoroutineScope, locker: SmartRWLocker = SmartRWLocker(), idGetter: (ObjectType) -> IdType): WriteCRUDCacheRepo<ObjectType, IdType, InputType>

convert

@JvmName(name = "convertFromT2")

suspend fun <T1, T2> SimpleSuspendableMapper<T1, T2>.convert(from: T2): T1

Converts from of type T2 to type T1 using this suspending mapper.

@JvmName(name = "convertFromT1")

suspend fun <T1, T2> SimpleSuspendableMapper<T1, T2>.convert(from: T1): T2

Converts from of type T1 to type T2 using this suspending mapper.

convertToT1

open suspend override fun convertToT1(from: ToInput): FromInput

convertToT2

open suspend override fun convertToT2(from: FromInput): ToInput

create

open suspend override fun create(values: List<FromInput>): List<FromRegistered>

Creates new objects from the given list of input values. Successfully created objects must be emitted via newObjectsFlow.

create

suspend fun <ObjectType, IdType, InputValueType> WriteCRUDRepo<ObjectType, IdType, InputValueType>.create(vararg values: InputValueType): List<ObjectType>

Vararg overload of WriteCRUDRepo.create for convenience.

deleteById

open suspend override fun deleteById(ids: List<FromId>)

Deletes objects with the given list of IDs. Successfully deleted IDs must be emitted via deletedObjectsIdsFlow.

deleteById

suspend fun <ObjectType, IdType, InputValueType> WriteCRUDRepo<ObjectType, IdType, InputValueType>.deleteById(vararg ids: IdType)

Vararg overload of WriteCRUDRepo.deleteById for convenience.

toInnerKey

open suspend override fun ToId.toInnerKey(): FromId

Converts a key from the outer type to the inner type.

toInnerValue

open suspend override fun ToRegistered.toInnerValue(): FromRegistered

Converts a value from the outer type to the inner type.

toOutKey

open suspend override fun FromId.toOutKey(): ToId

Converts a key from the inner type to the outer type.

toOutValue

open suspend override fun FromRegistered.toOutValue(): ToRegistered

Converts a value from the inner type to the outer type.

update

open suspend override fun update(values: List<UpdatedValuePair<FromId, FromInput>>): List<FromRegistered>

Batch-updates objects using the given list of ID-value pairs. Successfully updated objects must be emitted via updatedObjectsFlow.

open suspend override fun update(id: FromId, value: FromInput): FromRegistered?

Updates the object identified by id with the given value. Successfully updated object must be emitted via updatedObjectsFlow.

update

suspend fun <ObjectType, IdType, InputValueType> WriteCRUDRepo<ObjectType, IdType, InputValueType>.update(vararg values: UpdatedValuePair<IdType, InputValueType>): List<ObjectType>

Vararg overload of WriteCRUDRepo.update for convenience.

withMapper

inline fun <FromKey, FromValue, FromInput, ToKey, ToValue, ToInput> WriteCRUDRepo<ToValue, ToKey, ToInput>.withMapper(mapper: MapperRepo<FromKey, FromValue, ToKey, ToValue>, simpleSuspendableMapper: SimpleSuspendableMapper<FromInput, ToInput>): WriteCRUDRepo<FromValue, FromKey, FromInput>

inline fun <FromKey, FromValue, FromInput, ToKey, ToValue, ToInput> WriteCRUDRepo<ToValue, ToKey, ToInput>.withMapper(noinline keyFromToTo: suspend FromKey.() -> ToKey = { this as ToKey }, noinline valueFromToTo: suspend FromValue.() -> ToValue = { this as ToValue }, noinline inputFromToTo: suspend FromInput.() -> ToInput = { this as ToInput }, noinline keyToToFrom: suspend ToKey.() -> FromKey = { this as FromKey }, noinline valueToToFrom: suspend ToValue.() -> FromValue = { this as FromValue }, noinline inputToToFrom: suspend ToInput.() -> FromInput = { this as FromInput }): WriteCRUDRepo<FromValue, FromKey, FromInput>