Skip to content

Commit

Permalink
Generated updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chRyNaN committed Aug 27, 2024
1 parent 359d26f commit bc86a2d
Show file tree
Hide file tree
Showing 32 changed files with 163 additions and 163 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ expect fun interface [SaverScope](index.md)
actual fun interface [SaverScope](index.md)

[android, jvm]\
actual typealias [SaverScope](index.md) = [SaverScope](https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/SaverScope.html)
actual typealias [SaverScope](index.md) = [androidx.compose.runtime.saveable.SaverScope](https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/SaverScope.html)

## Functions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ expect interface [Saver](index.md)<[Original](index.md), [Saveable](index.md)
actual interface [Saver](index.md)<[Original](index.md), [Saveable](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>

[android, jvm]\
actual typealias [Saver](index.md) = [Saver](https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/Saver.html)<[Original](index.md), [Saveable](index.md)>
actual typealias [Saver](index.md)<[Original](index.md), [Saveable](index.md)> = [androidx.compose.runtime.saveable.Saver](https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/Saver.html)<[Original](index.md), [Saveable](index.md)>

## Functions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

| Name | Summary |
|---|---|
| [Saver](-saver/index.md) | [common, js, native, wasmJs, android, jvm]<br>[common]<br>expect interface [Saver](-saver/index.md)&lt;[Original](-saver/index.md), [Saveable](-saver/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;<br>[js, native, wasmJs]<br>actual interface [Saver](-saver/index.md)&lt;[Original](-saver/index.md), [Saveable](-saver/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;<br>[android, jvm]<br>actual typealias [Saver](-saver/index.md) = [Saver](https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/Saver.html)&lt;[Original](-saver/index.md), [Saveable](-saver/index.md)&gt; |
| [SaverScope](-saver-scope/index.md) | [common, js, native, wasmJs, android, jvm]<br>[common]<br>expect fun interface [SaverScope](-saver-scope/index.md)<br>[js, native, wasmJs]<br>actual fun interface [SaverScope](-saver-scope/index.md)<br>[android, jvm]<br>actual typealias [SaverScope](-saver-scope/index.md) = [SaverScope](https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/SaverScope.html) |
| [Saver](-saver/index.md) | [common, js, native, wasmJs, android, jvm]<br>[common]<br>expect interface [Saver](-saver/index.md)&lt;[Original](-saver/index.md), [Saveable](-saver/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;<br>[js, native, wasmJs]<br>actual interface [Saver](-saver/index.md)&lt;[Original](-saver/index.md), [Saveable](-saver/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;<br>[android, jvm]<br>actual typealias [Saver](-saver/index.md)&lt;[Original](-saver/index.md), [Saveable](-saver/index.md)&gt; = [androidx.compose.runtime.saveable.Saver](https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/Saver.html)&lt;[Original](-saver/index.md), [Saveable](-saver/index.md)&gt; |
| [SaverScope](-saver-scope/index.md) | [common, js, native, wasmJs, android, jvm]<br>[common]<br>expect fun interface [SaverScope](-saver-scope/index.md)<br>[js, native, wasmJs]<br>actual fun interface [SaverScope](-saver-scope/index.md)<br>[android, jvm]<br>actual typealias [SaverScope](-saver-scope/index.md) = [androidx.compose.runtime.saveable.SaverScope](https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/SaverScope.html) |

## Functions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,29 @@

# AndroidParcel

class [AndroidParcel](index.md) : [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md)
class [AndroidParcel](index.md) : [Parcel](../-parcel/index.md)

An Android implementation of the [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md) interface. This class wraps the provided [android.os.Parcel](../../../../parcelable-core/com.chrynan.parcelable.core/-android-parcel/parcel.md) and delegates the reading and writing to it.
An Android implementation of the [Parcel](../-parcel/index.md) interface. This class wraps the provided [android.os.Parcel](../../../../parcelable-core/com.chrynan.parcelable.core/-android-parcel/parcel.md) and delegates the reading and writing to it.

Note that this class should not be confused with the [android.os.Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html). Instead, this class wraps that class and implements the [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md) interface of this library.
Note that this class should not be confused with the [android.os.Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html). Instead, this class wraps that class and implements the [Parcel](../-parcel/index.md) interface of this library.

#### See also

| |
|---|
| [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md) |
| [Parcel](../-parcel/index.md) |
| [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html) |

## Properties

| Name | Summary |
|---|---|
| [dataBufferCapacity](data-buffer-capacity.md) | [android]<br>open override val [dataBufferCapacity](data-buffer-capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>The total amount of space available in this parcel. This should always be greater than or equal to [dataSize](data-size.md). There may be more space available ([dataBufferCapacity](data-buffer-capacity.md)) in the underlying data buffer than there is data available ([dataSize](data-size.md)). The difference between [dataBufferCapacity](data-buffer-capacity.md) and [dataSize](data-size.md) indicates the amount of room remaining in the underlying data buffer until more space needs to be allocated. |
| [dataPosition](data-position.md) | [android]<br>open override val [dataPosition](data-position.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>The current index position in the data buffer. Should never be more than [dataSize](data-size.md). |
| [dataRemaining](../-parcel/data-remaining.md) | [android]<br>open val [dataRemaining](../-parcel/data-remaining.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>The remaining amount of data to be read ([dataSize](../-parcel/data-size.md) - [dataPosition](../-parcel/data-position.md)). |
| [dataSize](data-size.md) | [android]<br>open override val [dataSize](data-size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>The total amount of data contained in this parcel. |
| [isRecycled](is-recycled.md) | [android]<br>open override var [isRecycled](is-recycled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>Determines whether this [Parcel](../-parcel/index.md)s [recycle](recycle.md) function has been called already. A parcel object should not be used after it is recycled. |

## Functions

| Name | Summary |
Expand All @@ -30,10 +40,10 @@ Note that this class should not be confused with the [android.os.Parcel](https:/
| [readLong](read-long.md) | [android]<br>open override fun [readLong](read-long.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)<br>Retrieves a [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) from the Parcel at the current data position. |
| [readShort](read-short.md) | [android]<br>open override fun [readShort](read-short.md)(): [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html)<br>Retrieves a [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) from the Parcel at the current data position. |
| [readString](read-string.md) | [android]<br>open override fun [readString](read-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>Retrieves a [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) from the Parcel at the current data position. |
| [recycle](recycle.md) | [android]<br>open override fun [recycle](recycle.md)()<br>Puts this parcel object back into the pool, removing its data. This parcel object should not be used after it is recycled. Attempting to write or read from a recycled [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md) may cause an exception to be thrown. |
| [recycle](recycle.md) | [android]<br>open override fun [recycle](recycle.md)()<br>Puts this parcel object back into the pool, removing its data. This parcel object should not be used after it is recycled. Attempting to write or read from a recycled [Parcel](../-parcel/index.md) may cause an exception to be thrown. |
| [resetDataPosition](../reset-data-position.md) | [common]<br>inline fun [Parcel](../-parcel/index.md).[resetDataPosition](../reset-data-position.md)()<br>A convenience function for calling the [Parcel.setDataPosition](../-parcel/set-data-position.md) with an index value of zero. |
| [setDataPosition](set-data-position.md) | [android]<br>open override fun [setDataPosition](set-data-position.md)(position: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))<br>Sets the [dataPosition](data-position.md) to the provided [position](set-data-position.md) value. This will throw an exception if the provided [position](set-data-position.md) value is less than zero or exceeds [dataSize](data-size.md). |
| [toByteArray](to-byte-array.md) | [android]<br>open override fun [toByteArray](to-byte-array.md)(): [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)<br>Obtains a [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) of the underlying values of this [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md). Note that the returned [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) data is structured in a way that is meaningful for this implementation, but doesn't guarantee any structure for outside usage or usage between different implementations. |
| [toByteArray](to-byte-array.md) | [android]<br>open override fun [toByteArray](to-byte-array.md)(): [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)<br>Obtains a [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) of the underlying values of this [Parcel](../-parcel/index.md). Note that the returned [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) data is structured in a way that is meaningful for this implementation, but doesn't guarantee any structure for outside usage or usage between different implementations. |
| [toString](to-string.md) | [android]<br>open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
| [writeBoolean](write-boolean.md) | [android]<br>open override fun [writeBoolean](write-boolean.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))<br>Writes the [Boolean](write-boolean.md) to the Parcel at the current data position. |
| [writeByte](write-byte.md) | [android]<br>open override fun [writeByte](write-byte.md)(value: [Byte](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html))<br>Writes the [Byte](write-byte.md) to the Parcel at the current data position. |
Expand All @@ -44,13 +54,3 @@ Note that this class should not be confused with the [android.os.Parcel](https:/
| [writeLong](write-long.md) | [android]<br>open override fun [writeLong](write-long.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))<br>Writes the [Long](write-long.md) to the Parcel at the current data position. |
| [writeShort](write-short.md) | [android]<br>open override fun [writeShort](write-short.md)(value: [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html))<br>Writes the [Short](write-short.md) to the Parcel at the current data position. |
| [writeString](write-string.md) | [android]<br>open override fun [writeString](write-string.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))<br>Writes the [String](write-string.md) to the Parcel at the current data position. |

## Properties

| Name | Summary |
|---|---|
| [dataBufferCapacity](data-buffer-capacity.md) | [android]<br>open override val [dataBufferCapacity](data-buffer-capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>The total amount of space available in this parcel. This should always be greater than or equal to [dataSize](data-size.md). There may be more space available ([dataBufferCapacity](data-buffer-capacity.md)) in the underlying data buffer than there is data available ([dataSize](data-size.md)). The difference between [dataBufferCapacity](data-buffer-capacity.md) and [dataSize](data-size.md) indicates the amount of room remaining in the underlying data buffer until more space needs to be allocated. |
| [dataPosition](data-position.md) | [android]<br>open override val [dataPosition](data-position.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>The current index position in the data buffer. Should never be more than [dataSize](data-size.md). |
| [dataRemaining](index.md#-139993914%2FProperties%2F-1462739831) | [android]<br>open val [dataRemaining](index.md#-139993914%2FProperties%2F-1462739831): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>The remaining amount of data to be read ([dataSize](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/data-size.md) - [dataPosition](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/data-position.md)). |
| [dataSize](data-size.md) | [android]<br>open override val [dataSize](data-size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>The total amount of data contained in this parcel. |
| [isRecycled](is-recycled.md) | [android]<br>open override var [isRecycled](is-recycled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>Determines whether this [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md)s [recycle](recycle.md) function has been called already. A parcel object should not be used after it is recycled. |
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
[android]\
open override var [isRecycled](is-recycled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)

Determines whether this [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md)s [recycle](recycle.md) function has been called already. A parcel object should not be used after it is recycled.
Determines whether this [Parcel](../-parcel/index.md)s [recycle](recycle.md) function has been called already. A parcel object should not be used after it is recycled.

Note that this property is unstable between processes.
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
[android]\
open override fun [recycle](recycle.md)()

Puts this parcel object back into the pool, removing its data. This parcel object should not be used after it is recycled. Attempting to write or read from a recycled [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md) may cause an exception to be thrown.
Puts this parcel object back into the pool, removing its data. This parcel object should not be used after it is recycled. Attempting to write or read from a recycled [Parcel](../-parcel/index.md) may cause an exception to be thrown.
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ open override fun [setDataPosition](set-data-position.md)(position: [Int](https:

Sets the [dataPosition](data-position.md) to the provided [position](set-data-position.md) value. This will throw an exception if the provided [position](set-data-position.md) value is less than zero or exceeds [dataSize](data-size.md).

The position value represents an amount of bytes. For instance, an [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) is a 32-bit (4 byte) integer value, when it is stored in this [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md), the [dataSize](data-size.md) will increase by a value of four. To skip over the integer value to the next item, call this function with the current value plus four.
The position value represents an amount of bytes. For instance, an [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) is a 32-bit (4 byte) integer value, when it is stored in this [Parcel](../-parcel/index.md), the [dataSize](data-size.md) will increase by a value of four. To skip over the integer value to the next item, call this function with the current value plus four.
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
[android]\
open override fun [toByteArray](to-byte-array.md)(): [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)

Obtains a [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) of the underlying values of this [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md). Note that the returned [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) data is structured in a way that is meaningful for this implementation, but doesn't guarantee any structure for outside usage or usage between different implementations.
Obtains a [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) of the underlying values of this [Parcel](../-parcel/index.md). Note that the returned [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) data is structured in a way that is meaningful for this implementation, but doesn't guarantee any structure for outside usage or usage between different implementations.
Loading

0 comments on commit bc86a2d

Please sign in to comment.