Skip to content

Docs for Rust SDK #452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 18, 2024
Merged

Docs for Rust SDK #452

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8320427
Add docs for Rust SDK
z4kn4fein Jun 11, 2024
4844321
Fixup
z4kn4fein Jun 11, 2024
bd1c9b6
Apply PR suggestions
z4kn4fein Jun 12, 2024
4042e5b
Update rust.mdx
z4kn4fein Jun 12, 2024
bc6e135
Fixup get_value() parameter order
z4kn4fein Jun 12, 2024
b926c5d
Add log example
z4kn4fein Jun 13, 2024
eed634c
get_all_details() -> get_all_value_details()
z4kn4fein Jun 14, 2024
6d3de97
Add GH stars
z4kn4fein Jun 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions website/docs/sdk-reference/android.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ These are the available options on the `Options` class:
| Options | Description |
| ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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`. |
| `baseUrl(string)` | _Obsolete_ Optional, sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the config JSON. |
| `baseUrl(string)` | Optional, sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the config JSON. |
| `httpClient(OkHttpClient)` | Optional, sets the underlying `OkHttpClient` used to download the feature flags and settings over HTTP. [More about the HTTP Client](#httpclient). |
| `cache(ConfigCache)` | Optional, sets a custom cache implementation for the client. [More about cache](#custom-cache). |
| `pollingMode(PollingMode)` | Optional, sets the polling mode for the client. [More about polling modes](#polling-modes). |
Expand Down Expand Up @@ -635,7 +635,7 @@ Call the `forceRefresh()` method on the client to download the latest config JSO

## Logging

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

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

Expand Down
2 changes: 1 addition & 1 deletion website/docs/sdk-reference/go.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Available optional properties:
| ------------------ | -------------------------- | ------------ |
| `SDKKey` | `string` | SDK Key to access your feature flags and configurations. Get it from _ConfigCat Dashboard_. |
| `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`. |
| `BaseUrl` | `string` | _Obsolete_ Sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the configurations. |
| `BaseUrl` | `string` | Sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the configurations. |
| `Cache ` | `ConfigCache` | Sets a custom cache implementation for the client. [See below](#custom-cache). |
| `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. |
| `HttpTimeout` | `time.Duration` | Sets the maximum wait time for a HTTP response. [More about the HTTP timeout](#http-timeout) |
Expand Down
4 changes: 2 additions & 2 deletions website/docs/sdk-reference/java.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ These are the available options on the `Options` class:
| Option | Description |
| ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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`. |
| `baseUrl(string)` | _Obsolete_ Optional, sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the configurations. |
| `baseUrl(string)` | Optional, sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the configurations. |
| `httpClient(OkHttpClient)` | Optional, sets the underlying `OkHttpClient` used to download the feature flags and settings over HTTP. [More about the HTTP Client](#httpclient). |
| `cache(ConfigCache)` | Optional, sets a custom cache implementation for the client. [More about cache](#custom-cache). |
| `pollingMode(PollingMode)` | Optional, sets the polling mode for the client. [More about polling modes](#polling-modes). |
Expand Down Expand Up @@ -835,7 +835,7 @@ Call the `forceRefresh()` method on the client to download the latest config JSO

## Logging

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

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

Expand Down
2 changes: 1 addition & 1 deletion website/docs/sdk-reference/ruby.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ _ConfigCat Client_ is responsible for:

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