DragonX/dragonx-android-wallet-sdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
fekt
2022-06-30 01:53:12 -04:00
commit 0131016214
703 changed files with 33394 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/-twig/README.md Normal file
View File

@@ -0,0 +1,38 @@
[zcash-android-wallet-sdk](../../index.md) / [cash.z.ecc.android.sdk.ext](../index.md) / [Twig](./index.md)
# Twig
`interface Twig`
A tiny log.
### Functions
| Name | Summary |
|---|---|
| [plus](plus.md) | `open operator fun plus(twig: `[`Twig`](./index.md)`): `[`Twig`](./index.md) |
| [twig](twig.md) | `abstract fun twig(logMessage: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = ""): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) |
### Companion Object Functions
| Name | Summary |
|---|---|
| [clip](clip.md) | `fun clip(leaf: Leaf): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>Clip a leaf from the bush. Clipped leaves no longer appear in logs. |
| [plant](plant.md) | `fun plant(rootTwig: `[`Twig`](./index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)<br>Plants the twig, making it the one and only bush. Twigs can be bundled together to create the appearance of multiple bushes (i.e `Twig.plant(twigA + twigB + twigC)`) even though there's only ever one bush. |
| [prune](prune.md) | `fun prune(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)<br>Clip all leaves from the bush. |
| [sprout](sprout.md) | `fun sprout(leaf: Leaf): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>Generate a leaf on the bush. Leaves show up in every log message as tags until they are clipped. |
### Extension Functions
| Name | Summary |
|---|---|
| [twig](../twig.md) | `fun <R> `[`Twig`](./index.md)`.twig(logMessage: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, block: () -> `[`R`](../twig.md#R)`): `[`R`](../twig.md#R)<br>Times a tiny log. Execute the block of code on the clock. |
| [twigTask](../twig-task.md) | `fun <R> `[`Twig`](./index.md)`.twigTask(logMessage: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, block: () -> `[`R`](../twig-task.md#R)`): `[`R`](../twig-task.md#R)<br>A tiny log task. Execute the block of code with some twigging around the outside. For silent twigs, this adds a small amount of overhead at the call site but still avoids logging. |
### Inheritors
| Name | Summary |
|---|---|
| [CompositeTwig](../-composite-twig/index.md) | `open class CompositeTwig : `[`Twig`](./index.md)<br>Since there can only ever be one trunk on the bush of twigs, this class lets you cheat and make that trunk be a bundle of twigs. |
| [SilentTwig](../-silent-twig/index.md) | `class SilentTwig : `[`Twig`](./index.md)<br>A tiny log that does nothing. No one hears this twig fall in the woods. |
| [TroubleshootingTwig](../-troubleshooting-twig/index.md) | `open class TroubleshootingTwig : `[`Twig`](./index.md)<br>A tiny log for detecting troubles. Aim at your troubles and pull the twigger. |

8
docs/-twig/clip.md Normal file
View File

@@ -0,0 +1,8 @@
[zcash-android-wallet-sdk](../../index.md) / [cash.z.ecc.android.sdk.ext](../index.md) / [Twig](index.md) / [clip](./clip.md)
# clip
`fun clip(leaf: Leaf): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Clip a leaf from the bush. Clipped leaves no longer appear in logs.

38
docs/-twig/index.md Normal file
View File

@@ -0,0 +1,38 @@
[zcash-android-wallet-sdk](../../index.md) / [cash.z.ecc.android.sdk.ext](../index.md) / [Twig](./index.md)
# Twig
`interface Twig`
A tiny log.
### Functions
| Name | Summary |
|---|---|
| [plus](plus.md) | Bundles twigs together`open operator fun plus(twig: `[`Twig`](./index.md)`): `[`Twig`](./index.md) |
| [twig](twig.md) | Log the message. Simple.`abstract fun twig(logMessage: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = ""): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) |
### Companion Object Functions
| Name | Summary |
|---|---|
| [clip](clip.md) | Clip a leaf from the bush. Clipped leaves no longer appear in logs.`fun clip(leaf: Leaf): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) |
| [plant](plant.md) | Plants the twig, making it the one and only bush. Twigs can be bundled together to create the appearance of multiple bushes (i.e `Twig.plant(twigA + twigB + twigC)`) even though there's only ever one bush.`fun plant(rootTwig: `[`Twig`](./index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) |
| [prune](prune.md) | Clip all leaves from the bush.`fun prune(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) |
| [sprout](sprout.md) | Generate a leaf on the bush. Leaves show up in every log message as tags until they are clipped.`fun sprout(leaf: Leaf): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) |
### Extension Functions
| Name | Summary |
|---|---|
| [twig](../twig.md) | Times a tiny log. Execute the block of code on the clock.`fun <R> `[`Twig`](./index.md)`.twig(logMessage: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, block: () -> R): R` |
| [twigTask](../twig-task.md) | A tiny log task. Execute the block of code with some twigging around the outside. For silent twigs, this adds a small amount of overhead at the call site but still avoids logging.`fun <R> `[`Twig`](./index.md)`.twigTask(logMessage: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, block: () -> R): R` |
### Inheritors
| Name | Summary |
|---|---|
| [CompositeTwig](../-composite-twig/index.md) | Since there can only ever be one trunk on the bush of twigs, this class lets you cheat and make that trunk be a bundle of twigs.`open class CompositeTwig : `[`Twig`](./index.md) |
| [SilentTwig](../-silent-twig/index.md) | A tiny log that does nothing. No one hears this twig fall in the woods.`class SilentTwig : `[`Twig`](./index.md) |
| [TroubleshootingTwig](../-troubleshooting-twig/index.md) | A tiny log for detecting troubles. Aim at your troubles and pull the twigger.`open class TroubleshootingTwig : `[`Twig`](./index.md) |

9
docs/-twig/plant.md Normal file
View File

@@ -0,0 +1,9 @@
[zcash-android-wallet-sdk](../../index.md) / [cash.z.ecc.android.sdk.ext](../index.md) / [Twig](index.md) / [plant](./plant.md)
# plant
`fun plant(rootTwig: `[`Twig`](index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Plants the twig, making it the one and only bush. Twigs can be bundled together to create the appearance of
multiple bushes (i.e `Twig.plant(twigA + twigB + twigC)`) even though there's only ever one bush.

8
docs/-twig/plus.md Normal file
View File

@@ -0,0 +1,8 @@
[zcash-android-wallet-sdk](../../index.md) / [cash.z.ecc.android.sdk.ext](../index.md) / [Twig](index.md) / [plus](./plus.md)
# plus
`open operator fun plus(twig: `[`Twig`](index.md)`): `[`Twig`](index.md)
Bundles twigs together

8
docs/-twig/prune.md Normal file
View File

@@ -0,0 +1,8 @@
[zcash-android-wallet-sdk](../../index.md) / [cash.z.ecc.android.sdk.ext](../index.md) / [Twig](index.md) / [prune](./prune.md)
# prune
`fun prune(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Clip all leaves from the bush.

8
docs/-twig/sprout.md Normal file
View File

@@ -0,0 +1,8 @@
[zcash-android-wallet-sdk](../../index.md) / [cash.z.ecc.android.sdk.ext](../index.md) / [Twig](index.md) / [sprout](./sprout.md)
# sprout
`fun sprout(leaf: Leaf): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Generate a leaf on the bush. Leaves show up in every log message as tags until they are clipped.

8
docs/-twig/twig.md Normal file
View File

@@ -0,0 +1,8 @@
[zcash-android-wallet-sdk](../../index.md) / [cash.z.ecc.android.sdk.ext](../index.md) / [Twig](index.md) / [twig](./twig.md)
# twig
`abstract fun twig(logMessage: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = ""): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Log the message. Simple.