Skip to content

Commit 80e2603

Browse files
z4kn4feinz4kn4fein
authored
Docs for Rust SDK (#452)
* Add docs for Rust SDK * Fixup * Apply PR suggestions * Update rust.mdx * Fixup get_value() parameter order * Add log example * get_all_details() -> get_all_value_details() * Add GH stars
1 parent 991f82e commit 80e2603

File tree

14 files changed

+1434
-11
lines changed

14 files changed

+1434
-11
lines changed

‎website/docs/sdk-reference/android.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ These are the available options on the `Options` class:
109109
| Options | Description |
110110
| ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
111111
| `dataGovernance(DataGovernance)` | Optional, defaults to `Global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](../advanced/data-governance.mdx). Available options: `Global`, `EuOnly`. |
112-
| `baseUrl(string)` | _Obsolete_ Optional, sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the config JSON. |
112+
| `baseUrl(string)` | Optional, sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the config JSON. |
113113
| `httpClient(OkHttpClient)` | Optional, sets the underlying `OkHttpClient` used to download the feature flags and settings over HTTP. [More about the HTTP Client](#httpclient). |
114114
| `cache(ConfigCache)` | Optional, sets a custom cache implementation for the client. [More about cache](#custom-cache). |
115115
| `pollingMode(PollingMode)` | Optional, sets the polling mode for the client. [More about polling modes](#polling-modes). |
@@ -635,7 +635,7 @@ Call the `forceRefresh()` method on the client to download the latest config JSO
635635

636636
## Logging
637637

638-
As the SDK uses the facade of [slf4j](https://www.slf4j.org) for logging, so you can use any of the slf4j implementation packages.
638+
The SDK uses the facade of [slf4j](https://www.slf4j.org) for logging, so you can use any of the slf4j implementation packages.
639639

640640
You can change the verbosity of the logs by passing a `LogLevel` parameter to the ConfigCatClientBuilder's `logLevel` function.
641641

‎website/docs/sdk-reference/go.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Available optional properties:
8585
| ------------------ | -------------------------- | ------------ |
8686
| `SDKKey` | `string` | SDK Key to access your feature flags and configurations. Get it from _ConfigCat Dashboard_. |
8787
| `DataGovernance` | `configcat.DataGovernance` | Defaults to `Global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](../advanced/data-governance.mdx). Available options: `Global`, `EuOnly`. |
88-
| `BaseUrl` | `string` | _Obsolete_ Sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the configurations. |
88+
| `BaseUrl` | `string` | Sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the configurations. |
8989
| `Cache ` | `ConfigCache` | Sets a custom cache implementation for the client. [See below](#custom-cache). |
9090
| `NoWaitForRefresh` | `bool` | Defaults to `false`. When it's `true` the typed get methods (`Get[TYPE]Value()`) will never wait for a configuration refresh to complete before returning. When it's `false` and `PollingMode` is `AutoPoll`, the first request may block, when `PollingMode` is `Lazy`, any request may block. |
9191
| `HttpTimeout` | `time.Duration` | Sets the maximum wait time for a HTTP response. [More about the HTTP timeout](#http-timeout) |

‎website/docs/sdk-reference/java.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ These are the available options on the `Options` class:
114114
| Option | Description |
115115
| ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
116116
| `dataGovernance(DataGovernance)` | Optional, defaults to `Global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](../advanced/data-governance.mdx). Available options: `Global`, `EuOnly`. |
117-
| `baseUrl(string)` | _Obsolete_ Optional, sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the configurations. |
117+
| `baseUrl(string)` | Optional, sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the configurations. |
118118
| `httpClient(OkHttpClient)` | Optional, sets the underlying `OkHttpClient` used to download the feature flags and settings over HTTP. [More about the HTTP Client](#httpclient). |
119119
| `cache(ConfigCache)` | Optional, sets a custom cache implementation for the client. [More about cache](#custom-cache). |
120120
| `pollingMode(PollingMode)` | Optional, sets the polling mode for the client. [More about polling modes](#polling-modes). |
@@ -835,7 +835,7 @@ Call the `forceRefresh()` method on the client to download the latest config JSO
835835

836836
## Logging
837837

838-
As the SDK uses the facade of [slf4j](https://www.slf4j.org) for logging, so you can use any of the slf4j implementation packages.
838+
The SDK uses the facade of [slf4j](https://www.slf4j.org) for logging, so you can use any of the slf4j implementation packages.
839839

840840
You can change the verbosity of the logs by passing a `LogLevel` parameter to the ConfigCatClientBuilder's `logLevel` function.
841841

‎website/docs/sdk-reference/ruby.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ _ConfigCat Client_ is responsible for:
6868

6969
| Client options | Description | Default |
7070
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
71-
| `base_url` | _Obsolete_, sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the config JSON. | nil |
71+
| `base_url` | Sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the config JSON. | nil |
7272
| `polling_mode` | Sets the polling mode for the client. [More about polling modes](#polling-modes). | PollingMode.auto_poll |
7373
| `config_cache` | Sets a custom config cache implementation for the client. [More about cache](#custom-cache). | nil |
7474
| `proxy_address` | Sets custom proxy address for the client. [More about proxy](#using-configcat-behind-a-proxy). | nil |

0 commit comments

Comments
 (0)