[package]
name = "ump-ng"
version = "0.2.1"
edition = "2021"
license = "0BSD"
# https://crates.io/category_slugs
categories = [ "concurrency", "asynchronous" ]
keywords = [ "channel", "threads", "sync", "message-passing" ]
repository = "https://repos.qrnch.tech/pub/ump-ng"
description = "Micro message passing library for threads/tasks communication."

[[bench]]
name = "add_server"
harness = false

[package.metadata.docs.rs]
rustdoc-args = ["--generate-link-to-definition"]

[lints.clippy]
all = { level = "deny", priority = -1 }
pedantic = { level = "warn", priority = -1 }
nursery = { level = "warn", priority = -1 }
cargo = { level = "warn", priority = -1 }

# This is a configuration file for the bacon tool
#
# Bacon repository: https://github.com/Canop/bacon
# Complete help on configuration: https://dystroy.org/bacon/config/
# You can also check bacon's own bacon.toml file
#  as an example: https://github.com/Canop/bacon/blob/main/bacon.toml

# For information about clippy lints, see:
# https://github.com/rust-lang/rust-clippy/blob/master/README.md

#default_job = "check"
default_job = "clippy-all"

[jobs.check]
command = ["cargo", "check", "--color", "always"]
need_stdout = false

[jobs.check-all]
command = ["cargo", "check", "--all-targets", "--color", "always"]

# need_stdout = false
[jobs.clippy-all]
command = [
    "cargo", "clippy",
    "--all-targets",
    "--color", "always",
]

























need_stdout = false

# This job lets you run
# - all tests: bacon test
# - a specific test: bacon test -- config::test_default_files
# - the tests of a package: bacon test -- -- -p config
[jobs.test]

  }

  /// Create a weak `Client` reference.
  #[must_use]
  pub fn weak(&self) -> Weak<P, S, R, E> {
    Weak(self.0.weak())
  }

  /// Create a special-purpose client that can only perform post operations.
  #[must_use]
  pub fn postclient(&self) -> Post<P, S, R, E> {
    Post(self.clone())
  }
}

impl<P, S, R, E> Clone for Client<P, S, R, E> {
  /// Clone a client.
  ///
  /// When a client is cloned the new object will be linked to the same server,
  /// but in all other respects the clone is a completely independent client.

impl<P, S, R, E> Weak<P, S, R, E> {
  #[must_use]
  pub fn upgrade(&self) -> Option<Client<P, S, R, E>> {
    self.0.upgrade().map(|x| Client(x))
  }
}


/// Special purpose client end-point that can only issue `Post` requests.
#[derive(Clone)]
#[repr(transparent)]
pub struct Post<P, S, R, E>(Client<P, S, R, E>);

impl<P, S, R, E> Post<P, S, R, E>
where
  P: 'static + Send,
  S: 'static + Send,
  R: 'static + Send,
  E: 'static + Send
{
  /// Transmit a uni-directional message to the server end-point.
  ///
  /// # Errors
  /// [`Error::ServerDisappeared`] means the [`Server`](super::Server)
  /// end-point has been dropped.
  pub fn post(&self, msg: P) -> Result<(), Error<E>> {
    self.0.post(msg)
  }
}

// vim: set ft=rust et sw=2 ts=2 sts=2 cinoptions=2 tw=79 :

mod err;
mod rctx;
mod server;

pub use err::Error;

pub use crate::{
  client::{Client, Post as PostClient, WaitReply, Weak as WeakClient},
  rctx::ReplyContext,
  server::{MsgType, Server}
};

/// Create a pair of linked [`Server`] and [`Client`] objects.
///
/// The [`Server`] object is used to wait for incoming messages from connected

# Change Log

⚠️  indicates a breaking change.

## [Unreleased]

[Details](/vdiff?from=ump-ng-0.2.1&to=trunk)

### Added

### Changed

### Removed

---

## [0.2.1] - 2024-09-26

[Details](/vdiff?from=ump-ng-0.2.0&to=ump-ng-0.2.1)

### Added

- Add `Client::postonly()` for spawning `PostClient` objects.
- `PostClient` is a special purpose `Client` that can only issue _post_
  operations.

---

## [0.2.0] - 2024-09-10

[Details](/vdiff?from=ump-ng-0.1.0&to=ump-ng-0.2.0 )

### Changed

- Add some `Send` bounds to make `Future`s `Send`.
- Update to `swctx` to `0.3.0`, allowing `ReplyContext` to detect if the
  originating client has been dropped.
- ⚠️ Require `std::error::Error` bound on application-specific error `E` for