https://github.com/heaths/typestate-rs
Simple example of how the typestate builder pattern could be used for Azure SDKs for Rust
https://github.com/heaths/typestate-rs
Last synced: 12 months ago
JSON representation
Simple example of how the typestate builder pattern could be used for Azure SDKs for Rust
- Host: GitHub
- URL: https://github.com/heaths/typestate-rs
- Owner: heaths
- License: mit
- Created: 2024-04-10T23:14:51.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T00:35:17.000Z (about 2 years ago)
- Last Synced: 2025-01-01T10:16:47.496Z (over 1 year ago)
- Language: Rust
- Homepage: http://heaths.dev/typestate-rs/
- Size: 32.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Typestate Builder Example
This is an example of the typestate builder pattern we could use for client construction in Azure SDKs for Rust.
You can open [examples/typestate_builder.rs](examples/typestate_builder.rs) in GitHub Codespaces
to familiarize yourself with the developer experience.
This pattern guides the developer into only valid variants. In this example, they must first specify either an endpoint or connection string,
then only if they specify an endpoint can they specify either a `TokenCredential` or SAS token. After either of those branches, they can
specify other options or call `build()` to construct the `BlobClient`.
This example uses a builder that consumes `self` such that `--release` code will either move memory or even elide the move.
Conversely, we could take a `&mut self` and mutate the builder, returning a copy only from `build()` to support constructing separate clients
from the same - or modified between calls to `build()` - builder.
The same pattern could be used for client methods as well, though a simple builder - one not using type parameters - should suffice.
## Example
The following example shows how to construct a client using a builder. After typing `Client::builder().`, you'll only see methods
from a few blanket implementations and connection options. Depending on the connection option you specified e.g., the endpoint,
you'll see authentication options. Only when all required options are populated will you see general options such as setting retry options.
```rust
use azure_core::{Result, RetryOptions};
use azure_identity::DefaultAzureCredential;
use azure_typestate_example::BlobClient;
use std::sync::Arc;
fn new_blob_client(endpoint: &str) -> Result {
BlobClient::builder()
.with_endpoint(endpoint)
.with_credential(Arc::new(DefaultAzureCredential::default()))
.with_retry(RetryOptions::none())
.build()
}
```
## Documentation
The type parameters are not included in [documentation](https://heaths.dev/typestate-rs), such that developers would see all
client builder methods documented together.
## License
Licensed under the [MIT](LICENSE.txt) license.