selfie-lib/com.diffplug.selfie

Package-level declarations

Types

class ArrayMap<K : Comparable<K>, V : Any>(data: Array<Any>) : Map<K, V>

An immutable, sorted, array-backed map - if keys are String, they have a special sort order where / is the lowest key.

ArraySet

class ArraySet<K : Comparable<K>>(data: Array<Any>) : ListBackedSet<K>

An immutable, sorted, array-backed set - if keys are String, they have a special sort order where / is the lowest key.

BinaryFacet

interface BinaryFacet : FluentFacet

BinarySelfie

class BinarySelfie(val actual: Snapshot, disk: DiskStorage, onlyFacet: String) : DiskSelfie, BinaryFacet

BooleanSelfie

class BooleanSelfie(actual: Boolean)

Cacheable

fun interface Cacheable<T>

A getter which may or may not be run.

CacheSelfie

class CacheSelfie<T>(disk: DiskStorage, roundtrip: Roundtrip<T, String>, generator: Cacheable<T>)

CacheSelfieBinary

class CacheSelfieBinary<T>(disk: DiskStorage, roundtrip: Roundtrip<T, ByteArray>, generator: Cacheable<T>)

Camera

fun interface Camera<Subject>

A camera transforms a subject of a specific type into a Snapshot (tutorial for jvm).

CompoundLens

open class CompoundLens : Lens

A lens which makes it easy to pipe data from one facet to another within a snapshot (tutorial for jvm).

DiskSelfie

open class DiskSelfie : FluentFacet

A selfie which can be stored into a selfie-managed file.

class E<K, V>(val key: K, val value: V) : Map.Entry<K, V>

FluentFacet

interface FluentFacet

IntSelfie

class IntSelfie(actual: Int)

Lens

fun interface Lens

A lens transforms a single Snapshot into a new Snapshot, transforming / creating / removing SnapshotValues along the way (tutorial for jvm).

LineReader

class LineReader

ListBackedSet

abstract class ListBackedSet<T> : AbstractSet<T>

LongSelfie

class LongSelfie(actual: Long)

Mode

enum Mode : Enum<Mode>

ParseException

class ParseException : IllegalArgumentException

PerCharacterEscaper

class PerCharacterEscaper

If your escape policy is "'123", it means this:

Roundtrip

interface Roundtrip<T, SerializedForm>

RoundtripJson

class RoundtripJson<T>(strategy: KSerializer<T>) : Roundtrip<T, String>

Roundtrips the given type into pretty-printed Json.

Selfie

object Selfie

Static methods for creating snapshots.

Snapshot

data class Snapshot

SnapshotFile

class SnapshotFile

SnapshotReader

class SnapshotReader(val valueReader: SnapshotValueReader)

SnapshotValue

sealed interface SnapshotValue

SnapshotValueReader

class SnapshotValueReader(val lineReader: LineReader)

Provides the ability to parse a snapshot file incrementally.

StringFacet

expect interface StringFacet : FluentFacet

actual interface StringFacet : FluentFacet

StringOptionalFunction

fun interface StringOptionalFunction

A function which transforms a string into either another string or null.

StringSelfie

class StringSelfie(val actual: Snapshot, disk: DiskStorage, onlyFacets: Collection<String>? = null) : DiskSelfie, StringFacet

Functions

cacheSelfieBinarySerializable

fun <T : Serializable> Selfie.cacheSelfieBinarySerializable(toCache: Cacheable<T>): CacheSelfieBinary<T>