Skip to content

Commit 7bcaeda

Browse files
committed
add overload for Path
Path claims it has better platform independence, unicode support and better performance, so people might have reason to choose it over File
1 parent 0613f4e commit 7bcaeda

File tree

3 files changed

+9
-0
lines changed
  • core/src
    • main/kotlin/org/jetbrains/kotlinx/dataframe/io
    • test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api
  • docs/StardustDocs/topics

3 files changed

+9
-0
lines changed

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/html.kt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,10 @@ import java.awt.Desktop
2626
import java.io.File
2727
import java.io.InputStreamReader
2828
import java.net.URL
29+
import java.nio.file.Path
2930
import java.util.LinkedList
3031
import java.util.Random
32+
import kotlin.io.path.writeText
3133

3234
internal val tooltipLimit = 1000
3335

@@ -244,6 +246,10 @@ public data class DataFrameHtmlData(val style: String = "", val body: String = "
244246
destination.writeText(toString())
245247
}
246248

249+
public fun writeHTML(destination: Path) {
250+
destination.writeText(toString())
251+
}
252+
247253
public fun openInBrowser() {
248254
val file = File.createTempFile("df_rendering", ".html")
249255
writeHTML(file)

core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/Render.kt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package org.jetbrains.kotlinx.dataframe.samples.api
22

33
import java.io.File
4+
import kotlin.io.path.Path
45
import org.jetbrains.kotlinx.dataframe.api.reorderColumnsByName
56
import org.jetbrains.kotlinx.dataframe.api.sortBy
67
import org.jetbrains.kotlinx.dataframe.api.sortByDesc
@@ -18,6 +19,7 @@ class Render : TestBase() {
1819
// SampleStart
1920
df.toStandaloneHTML(DisplayConfiguration(rowsLimit = null)).openInBrowser()
2021
df.toStandaloneHTML(DisplayConfiguration(rowsLimit = null)).writeHTML(File("/path/to/file"))
22+
df.toStandaloneHTML(DisplayConfiguration(rowsLimit = null)).writeHTML(Path("/path/to/file"))
2123
// SampleEnd
2224
}
2325

docs/StardustDocs/topics/toHTML.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Following function produces HTML that includes JS and CSS definitions. It can be
1919
```kotlin
2020
df.toStandaloneHTML(DisplayConfiguration(rowsLimit = null)).openInBrowser()
2121
df.toStandaloneHTML(DisplayConfiguration(rowsLimit = null)).writeHTML(File("/path/to/file"))
22+
df.toStandaloneHTML(DisplayConfiguration(rowsLimit = null)).writeHTML(Path("/path/to/file"))
2223
```
2324

2425
<!---END-->

0 commit comments

Comments
 (0)