# AtomicFileKt

Added in 1.1.0

*** ** * ** ***


```
public final class AtomicFileKt
```

<br />

*** ** * ** ***

## Summary

| ### Public methods |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull byte[]` | `https://developer.android.com/reference/androidx/core/util/AtomicFileKt#(android.util.AtomicFile).readBytes()(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/util/AtomicFile.html receiver)` Gets the entire content of this file as a byte array. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/core/util/AtomicFileKt#(android.util.AtomicFile).readText(java.nio.charset.Charset)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/util/AtomicFile.html receiver, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/nio/charset/Charset.html charset)` Gets the entire content of this file as a String using UTF-8 or specified `https://developer.android.com/reference/androidx/core/util/package-summary#(android.util.AtomicFile).readText(java.nio.charset.Charset)`. |
| `static final void` | `https://developer.android.com/reference/androidx/core/util/AtomicFileKt#(android.util.AtomicFile).tryWrite(kotlin.Function1)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/util/AtomicFile.html receiver, @https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/io/FileOutputStream.html, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> block )` Perform the write operations inside `https://developer.android.com/reference/androidx/core/util/package-summary#(android.util.AtomicFile).tryWrite(kotlin.Function1)` on this file. |
| `static final void` | `https://developer.android.com/reference/androidx/core/util/AtomicFileKt#(android.util.AtomicFile).writeBytes(kotlin.ByteArray)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/util/AtomicFile.html receiver, @https://developer.android.com/reference/androidx/annotation/NonNull byte[] array)` Sets the content of this file as an `https://developer.android.com/reference/androidx/core/util/package-summary#(android.util.AtomicFile).writeBytes(kotlin.ByteArray)` of bytes. |
| `static final void` | `https://developer.android.com/reference/androidx/core/util/AtomicFileKt#(android.util.AtomicFile).writeText(kotlin.String,java.nio.charset.Charset)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/util/AtomicFile.html receiver, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html text, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/nio/charset/Charset.html charset )` Sets the content of this file as `https://developer.android.com/reference/androidx/core/util/package-summary#(android.util.AtomicFile).writeText(kotlin.String,java.nio.charset.Charset)` encoded using UTF-8 or specified `https://developer.android.com/reference/androidx/core/util/package-summary#(android.util.AtomicFile).writeText(kotlin.String,java.nio.charset.Charset)`. |

## Public methods

### readBytes

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/util/AtomicFile.kt+function:readBytes) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final @NonNull byte[] readBytes(@NonNull AtomicFile receiver)
```

Gets the entire content of this file as a byte array.

This method is not recommended on huge files. It has an internal limitation of 2 GB file size.

### readText

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/util/AtomicFile.kt+function:readText) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final @NonNull String readText(@NonNull AtomicFile receiver, @NonNull Charset charset)
```

Gets the entire content of this file as a String using UTF-8 or specified `https://developer.android.com/reference/androidx/core/util/package-summary#(android.util.AtomicFile).readText(java.nio.charset.Charset)`.

This method is not recommended on huge files. It has an internal limitation of 2 GB file size.

### tryWrite

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/util/AtomicFile.kt+function:tryWrite) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final void tryWrite(
    @NonNull AtomicFile receiver,
    @NonNull Function1<@NonNull FileOutputStream, Unit> block
)
```

Perform the write operations inside `https://developer.android.com/reference/androidx/core/util/package-summary#(android.util.AtomicFile).tryWrite(kotlin.Function1)` on this file. If `https://developer.android.com/reference/androidx/core/util/package-summary#(android.util.AtomicFile).tryWrite(kotlin.Function1)` throws an exception the write will be failed. Otherwise the write will be applied atomically to the file.

### writeBytes

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/util/AtomicFile.kt+function:writeBytes) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final void writeBytes(@NonNull AtomicFile receiver, @NonNull byte[] array)
```

Sets the content of this file as an `https://developer.android.com/reference/androidx/core/util/package-summary#(android.util.AtomicFile).writeBytes(kotlin.ByteArray)` of bytes.

### writeText

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/util/AtomicFile.kt+function:writeText) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final void writeText(
    @NonNull AtomicFile receiver,
    @NonNull String text,
    @NonNull Charset charset
)
```

Sets the content of this file as `https://developer.android.com/reference/androidx/core/util/package-summary#(android.util.AtomicFile).writeText(kotlin.String,java.nio.charset.Charset)` encoded using UTF-8 or specified `https://developer.android.com/reference/androidx/core/util/package-summary#(android.util.AtomicFile).writeText(kotlin.String,java.nio.charset.Charset)`. If this file exists, it becomes overwritten.