Compare commits

..

1 Commits

Author SHA1 Message Date
cuddle-please
de99a2fe16 chore(release): 0.1.3
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing
2025-07-04 11:29:11 +00:00
3 changed files with 24 additions and 10 deletions

View File

@ -6,10 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
## [0.1.3] - 2025-07-06
## [0.1.3] - 2025-07-04
### Added
- do publish
- allow readme
## [0.1.2] - 2025-07-04

2
Cargo.lock generated
View File

@ -645,7 +645,7 @@ dependencies = [
[[package]]
name = "noleader"
version = "0.1.2"
version = "0.1.1"
dependencies = [
"anyhow",
"async-nats",

View File

@ -22,9 +22,9 @@ This library is still young and the API is subject to change.
## Intended use-case
Noleader is not built for distributed consensus, or fast re-election procedures. It take upwards to a minute to get re-elected, state is the users responsibility to handle.
Noleader is not built for distributed consensus, or fast re-election produces. It take upwards to a minute to get reelected, state is the users responsibility to handle.
Noleader is pretty much just a distributed lock, intended for use-cases where the user wants to only have a single node scheduling work etc.
Noleader is pretty much just a distributed lock, intended for use-cases where the use wants to only have a single node scheduling work etc.
Good alternatives are:
@ -97,14 +97,29 @@ async fn main() -> anyhow::Result<()> {
}
```
## Examples
## API Overview
See the examples folder in ./crates/noleader/examples
* **`Leader::new(bucket: &str, key: &str, client: async_nats::Client) -> Leader`**
Create a new election participant.
* **`create_bucket(&self) -> anyhow::Result<()>`**
Ensures the KV bucket exists (no-op if already created).
* **`start(&self, token: CancellationToken) -> anyhow::Result<()>`**
Begins the background leader-election loop; renews TTL on success or retries on failure.
* **`do_while_leader<F, Fut>(&self, f: F) -> anyhow::Result<()>`**
Runs your closure as long as you hold leadership; cancels immediately on loss.
* **`leader_id(&self) -> Uuid`**
Returns your unique candidate ID.
* **`is_leader(&self) -> Status`**
Returns `Status::Leader` or `Status::Candidate`, taking shutdown into account.
## Architecture
Noleader uses a simple election stealing
### Types
```rust
pub enum Status {
Leader,
Candidate,
}
```
## License