kris-io/ch.difty.kris

Package-level declarations

KRisIO can be used from Java or Kotlin to work with exiting readers, files or streams.
ExportExtensions contains extension functions to the kotlin client for exporting RisRecords.
ImportExtensions contains extension functions to the kotlin client for importing RisRecords.

Types

object DefaultDispatcherProvider : DispatcherProvider

Provides access to the different types of CoroutineDispatchers, defaulting to the regular kotlin Dispatcher implementation.

KRisIO

object KRisIO

Convenience methods offering to directly work with IO methods.

Functions

@JvmOverloads

fun File.accept(records: List<RisRecord>, sort: List<String> = emptyList(), dispatchers: DispatcherProvider = DefaultDispatcherProvider)

Converts a list of RisRecords into a list of Strings in RIS file format, writing them into the File provided as receiver. Optionally accepts a list of names of RisTags defining a sort order for the RisTags in the file.

@JvmOverloads

fun OutputStream.accept(records: List<RisRecord>, sort: List<String> = emptyList(), dispatchers: DispatcherProvider = DefaultDispatcherProvider)

Converts a list of RisRecords into a list of Strings in RIS file format, writing them into the OutputStream provided as receiver. Optionally accepts a list of names of RisTags defining a sort order for the RisTags in the file.

@JvmOverloads

fun Writer.accept(records: List<RisRecord>, sort: List<String> = emptyList(), dispatchers: DispatcherProvider = DefaultDispatcherProvider)

Converts a list of RisRecords into a list of Strings in RIS file format, dumping them into the Writer provided as receiver. Optionally accepts a list of names of RisTags defining a sort order for the RisTags in the file.

@JvmOverloads

fun String.accept(records: List<RisRecord>, sort: List<String> = emptyList(), dispatchers: DispatcherProvider = DefaultDispatcherProvider)

Converts a list of RisRecords into a list of Strings in RIS file format, writing them into file with the path provided as the receiver, if possible. Optionally accepts a list of names of RisTags defining a sort order for the RisTags in the file.

process

@JvmOverloads

fun File.process(dispatchers: DispatcherProvider = DefaultDispatcherProvider): List<RisRecord>

Converts the RISFile lines in the File provided as receiver into a list of RisRecords. May throw an IOException if the file cannot be read successfully, or a KRisException if the lines cannot be parsed successfully.

@JvmOverloads

fun InputStream.process(dispatchers: DispatcherProvider = DefaultDispatcherProvider): List<RisRecord>

Converts the RISFile lines provided by the InputStream as receiver into a list of RisRecords. May throw an IOException if the stream cannot be read successfully, or a KRisException if the lines cannot be parsed successfully.

@JvmOverloads

fun Reader.process(dispatchers: DispatcherProvider = DefaultDispatcherProvider): List<RisRecord>

Converts the RISFile lines provided by the Reader as receiver into a list of RisRecords. May throw an IOException if the reader fails to deliver lines or a KRisException if the lines cannot be parsed successfully.

@JvmOverloads

fun String.process(dispatchers: DispatcherProvider = DefaultDispatcherProvider): List<RisRecord>

Converts the RISFile lines from the file with the path provided as receiver into a list of RisRecords. May throw an IOException if the file cannot be read successfully, or a KRisException if the lines cannot be parsed successfully.

processToStream

@JvmOverloads

fun File.processToStream(dispatchers: DispatcherProvider = DefaultDispatcherProvider): Stream<RisRecord>

Converts the RISFile lines in the File provided as receiver into a stream of RisRecords. May throw an IOException if the file cannot be read successfully, or a KRisException if the lines cannot be parsed successfully.

@JvmOverloads

fun InputStream.processToStream(dispatchers: DispatcherProvider = DefaultDispatcherProvider): Stream<RisRecord>

Converts the RISFile lines provided by the InputStream as receiver into a stream of RisRecords. May throw an IOException if the stream cannot be read successfully, or a KRisException if the lines cannot be parsed successfully.

@JvmOverloads

fun Reader.processToStream(dispatchers: DispatcherProvider = DefaultDispatcherProvider): Stream<RisRecord>

Converts the RISFile lines provided by the Reader as receiver into a stream of RisRecords. May throw an IOException if the reader fails to deliver lines or a KRisException if the lines cannot be parsed successfully.

@JvmOverloads

fun String.processToStream(dispatchers: DispatcherProvider = DefaultDispatcherProvider): Stream<RisRecord>

Converts the RISFile lines from the file with the path provided as receiver into a stream of RisRecords. May throw an IOException if the file cannot be read successfully, or a KRisException if the lines cannot be parsed successfully.