selfie-lib/com.diffplug.selfie.guts

Package-level declarations

Types

AtomicRef

expect class AtomicRef<T>

actual class AtomicRef<T>

CallLocation

expect class CallLocation : Comparable<CallLocation>

actual data class CallLocation : Comparable<CallLocation>

Represents the line at which user code called into Selfie.

CallStack

class CallStack(val location: CallLocation, val restOfStack: List<CallLocation>)

Represents the callstack above a given CallLocation.

CommentTracker

class CommentTracker

Tracks whether a given file has a comment which allows it to be written to. Thread-safe on multithreaded platforms.

CoroutineDiskStorage

class CoroutineDiskStorage(val disk: DiskStorage) : AbstractCoroutineContextElement

Used by com.diffplug.selfie.SelfieSuspend.

DiskStorage

interface DiskStorage

Represents the disk storage for a specific test.

DiskWriteTracker

class DiskWriteTracker : WriteTracker<String, Snapshot>

interface FS

InlineWriteTracker

class InlineWriteTracker : WriteTracker<CallLocation, LiteralValue<*>>

Language

enum Language : Enum<Language>

LiteralFormat

abstract class LiteralFormat<T : Any>

LiteralValue

class LiteralValue<T : Any>(val expected: T?, val actual: T, val format: LiteralFormat<T>)

ReentrantLock

expect class ReentrantLock

actual class ReentrantLock

actual typealias ReentrantLock = java.util.concurrent.locks.ReentrantLock

SnapshotFileLayout

interface SnapshotFileLayout

SnapshotSystem

interface SnapshotSystem

NOT FOR ENDUSERS. Implemented by Selfie to integrate with various test frameworks.

SourceFile

class SourceFile(filename: String, content: String, val language: Language)

SourcePathCache

class SourcePathCache(functionToCache: (CallLocation) -> TypedPath?, capacity: Int)

ToBeFileLazyBytes

class ToBeFileLazyBytes(val location: TypedPath, val layout: SnapshotFileLayout, data: ByteArray)

ToBeFileWriteTracker

class ToBeFileWriteTracker : WriteTracker<TypedPath, ToBeFileLazyBytes>

TodoStub

enum TodoStub : Enum<TodoStub>

Some kinds of _TODO don't change the argument at all.

TypedPath

data class TypedPath(val absolutePath: String) : Comparable<TypedPath>

A unix-style path where trailing-slash means it is a folder.

WithinTestGC

class WithinTestGC

Handles garbage collection of snapshots within a single test.

WriteTracker

sealed class WriteTracker<K : Comparable<K>, V>

For tracking the writes of disk snapshots literals.

Properties

Lock

val Lock: ReentrantLock

Functions

atomic

expect fun <T> atomic(initial: T): AtomicRef<T>

Replace with atomicfu when stable.

actual fun <T> atomic(initial: T): AtomicRef<T>

initSnapshotSystem

expect fun initSnapshotSystem(): SnapshotSystem

actual fun initSnapshotSystem(): SnapshotSystem

reentrantLock

expect fun reentrantLock(): ReentrantLock

actual inline fun reentrantLock(): ReentrantLock

withLock

expect inline fun <T> ReentrantLock.withLock(block: () -> T): T

actual inline fun <T> ReentrantLock.withLock(block: () -> T): T