1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
//! A multiple-argument dispatch system for our RPC system.
//!
//! Our RPC functionality is polymorphic in Methods (what we're told to do) and
//! Objects (the things that we give the methods to); we want to be able to
//! provide different implementations for each method, on each object.
//!
//! ## Writing RPC functions
//! <a name="func"></a>
//!
//! To participate in this system, an RPC function must have a particular type:
//! ```rust,ignore
//! async fn my_rpc_func(
//! target: Arc<OBJTYPE>,
//! method: Box<METHODTYPE>,
//! ctx: Box<dyn rpc::Context>,
//! [ updates: rpc::UpdateSink<METHODTYPE::Update ] // this argument is optional!
//! ) -> Result<METHODTYPE::Output, impl Into<rpc::RpcError>>
//! { ... }
//! ```
//!
//! If the "updates" argument is present,
//! then you will need to use the `[Updates]` flag when registering this function.
//!
//! ## Registering RPC functions statically
//!
//! After writing a function in the form above,
//! you need to register it with the RPC system so that it can be invoked on objects of the right type.
//! The easiest way to do so is by registering it, using [`static_rpc_invoke_fn!`](crate::static_rpc_invoke_fn):
//!
//! ```rust,ignore
//! static_rpc_invoke_fn!{ my_rpc_func; my_other_rpc_func; }
//! ```
//!
//! You can register particular instantiations of generic types, if they're known ahead of time:
//! ```rust,ignore
//! static_rpc_invoke_fn!{ my_generic_fn::<PreferredRuntime>; }
//! ```
//!
//! ## Registering RPC functions at runtime.
//!
//! If you can't predict all the instantiations of your function in advance,
//! you can insert them into a [`DispatchTable`] at run time:
//! ```rust,ignore
//! fn install_my_rpc_methods<T>(table: &mut DispatchTable) {
//! table.insert(invoker_ent!(my_generic_fn::<T>));
//! table.insert(invoker_ent!(my_generic_fn_with_update::<T>));
//! }
//! ```
use std::any;
use std::collections::HashMap;
use std::pin::Pin;
use std::sync::Arc;
use futures::future::BoxFuture;
use futures::Sink;
use crate::{Context, DynMethod, Object, RpcError, SendUpdateError};
/// A type-erased serializable value.
#[doc(hidden)]
pub type RpcValue = Box<dyn erased_serde::Serialize + Send + 'static>;
/// The return type from an RPC function.
#[doc(hidden)]
pub type RpcResult = Result<RpcValue, RpcError>;
/// The return type from sending an update.
#[doc(hidden)]
pub type RpcSendResult = Result<RpcValue, SendUpdateError>;
/// A boxed future holding the result of an RPC method.
type RpcResultFuture = BoxFuture<'static, RpcResult>;
/// A boxed sink on which updates can be sent.
pub type BoxedUpdateSink = Pin<Box<dyn Sink<RpcValue, Error = SendUpdateError> + Send>>;
/// A boxed sink on which updates of a particular type can be sent.
//
// NOTE: I'd like our functions to be able to take `impl Sink<U>` instead,
// but that doesn't work with our macro nonsense.
// Instead, we might choose to specialize `Invoker` if we find that the
// extra boxing in this case ever matters.
pub type UpdateSink<U> = Pin<Box<dyn Sink<U, Error = SendUpdateError> + Send + 'static>>;
/// An installable handler for running a method on an object type.
///
/// Callers should not typically implement this trait directly;
/// instead, use one of its blanket implementations.
//
// (This trait isn't sealed because there _are_ theoretical reasons
// why you might want to provide a special implementation.)
pub trait Invocable: Send + Sync + 'static {
/// Return the type of object that this Invokable will accept.
fn object_type(&self) -> any::TypeId;
/// Return the type of method that this Invocable will accept.
fn method_type(&self) -> any::TypeId;
/// Describe the types for this Invocable. Used for debugging.
fn describe_invocable(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result;
/// Invoke a method on an object.
///
/// Requires that `obj` has the type `self.object_type()`,
/// and that `method` has the type `self.method_type()`.
fn invoke(
&self,
obj: Arc<dyn Object>,
method: Box<dyn DynMethod>,
ctx: Box<dyn Context>,
sink: BoxedUpdateSink,
) -> Result<RpcResultFuture, InvokeError>;
}
/// Helper: Declare a blanket implementation for Invocable.
///
/// We provide two blanket implementations:
/// Once over a fn() taking an update sink,
/// and once over a fn() not taking an update sink.
macro_rules! declare_invocable_impl {
{
// These arguments are used to fill in some blanks that we need to use
// when handling an update sink.
$( update_gen: $update_gen:ident,
update_arg: { $sink:ident: $update_arg:ty } ,
update_arg_where: { $($update_arg_where:tt)+ } ,
sink_fn: $sink_fn:expr
)?
} => {
impl<M, OBJ, Fut, S, E, $($update_gen)?> Invocable
for fn(Arc<OBJ>, Box<M>, Box<dyn Context + 'static> $(, $update_arg )? ) -> Fut
where
M: crate::Method,
OBJ: Object,
Fut: futures::Future<Output = Result<S, E>> + Send + 'static,
M::Output: From<S>,
RpcError: From<E>,
$( M::Update: From<$update_gen>, )?
$( $($update_arg_where)+ )?
{
fn object_type(&self) -> any::TypeId {
any::TypeId::of::<OBJ>()
}
fn method_type(&self) -> any::TypeId {
any::TypeId::of::<M>()
}
fn describe_invocable(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"Invocable({:?}.{:?})",
any::type_name::<OBJ>(),
any::type_name::<M>(),
)
}
fn invoke(
&self,
obj: Arc<dyn Object>,
method: Box<dyn DynMethod>,
ctx: Box<dyn Context>,
#[allow(unused)]
sink: BoxedUpdateSink,
) -> Result<RpcResultFuture, $crate::InvokeError> {
use futures::FutureExt;
#[allow(unused)]
use tor_async_utils::SinkExt as _;
let Ok(obj) = obj.downcast_arc::<OBJ>() else {
return Err(InvokeError::Bug($crate::internal!("Wrong object type")));
};
let Ok(method) = method.downcast::<M>() else {
return Err(InvokeError::Bug($crate::internal!("Wrong method type")));
};
$(
#[allow(clippy::redundant_closure_call)]
let $sink = {
($sink_fn)(sink)
};
)?
Ok(
(self)(obj, method, ctx $(, $sink)? )
.map(|r| {
let r: RpcResult = match r {
Ok(v) => Ok(Box::new(M::Output::from(v))),
Err(e) => Err(RpcError::from(e)),
};
r
})
.boxed()
)
}
}
}
}
declare_invocable_impl! {}
declare_invocable_impl! {
update_gen: U,
update_arg: { sink: UpdateSink<U> },
update_arg_where: { U: 'static },
sink_fn: |sink:BoxedUpdateSink| Box::pin(
sink.with_fn(|update: U| RpcSendResult::Ok(
Box::new(M::Update::from(update))
)
))
}
/// An annotated Invocable; used to compile a [`DispatchTable`].
///
/// Do not construct this type directly! Instead, use [`invoker_ent!`](crate::invoker_ent!).
#[allow(clippy::exhaustive_structs)]
#[derive(Clone, Copy)]
#[must_use]
pub struct InvokerEnt {
#[doc(hidden)]
pub invoker: &'static (dyn Invocable),
// These fields are used to make sure that we aren't installing different
// functions for the same (Object, Method) pair.
// This is a bit of a hack, but we can't do reliable comparison on fn(),
// so this is our next best thing.
#[doc(hidden)]
pub file: &'static str,
#[doc(hidden)]
pub line: u32,
#[doc(hidden)]
pub function: &'static str,
}
impl InvokerEnt {
/// Return true if these two entries appear to be the same declaration
/// for the same function.
//
// It seems like it should be possible to compare these by pointer equality, somehow.
// But that would have to be done by comparing `&dyn`, including their vtables,
// and Rust's vtables aren't at all stable. This is a sanity check, not critical
// for correctness or security, so it's fine that it will catch most mistakes but
// not deliberate abuse or exciting stunts.
fn same_decl(&self, other: &Self) -> bool {
self.file == other.file && self.line == other.line && self.function == other.function
}
}
/// Create an [`InvokerEnt`] around a single function.
///
/// Syntax:
/// ```rust,ignore
/// invoker_ent!( function )
/// ```
///
/// The function must be a `fn` item
/// (with all necessary generic parameters specified)
/// with the correct type for an RPC implementation function;
/// see the [module documentation](self).
#[macro_export]
macro_rules! invoker_ent {
{ $func:expr } => {
$crate::dispatch::InvokerEnt {
invoker: $crate::invocable_func_as_dyn_invocable!($func),
file: file!(),
line: line!(),
function: stringify!($func)
}
};
}
impl std::fmt::Debug for InvokerEnt {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
self.invoker.describe_invocable(f)
}
}
inventory::collect!(InvokerEnt);
/// Cause one or more RPC functions to be statically registered,
/// each for handling a single Method on a single Object type.
///
/// # Example
///
/// ```
/// use tor_rpcbase::{self as rpc, templates::*};
/// use derive_deftly::Deftly;
///
/// use futures::sink::{Sink, SinkExt};
/// use std::sync::Arc;
///
/// #[derive(Debug, Deftly)]
/// #[derive_deftly(Object)]
/// struct ExampleObject {}
/// #[derive(Debug, Deftly)]
/// #[derive_deftly(Object)]
/// struct ExampleObject2 {}
///
/// #[derive(Debug,serde::Deserialize, Deftly)]
/// #[derive_deftly(DynMethod)]
/// #[deftly(rpc(method_name = "arti:x-example"))]
/// struct ExampleMethod {}
/// impl rpc::Method for ExampleMethod {
/// type Output = ExampleResult;
/// type Update = Progress;
/// }
///
/// #[derive(serde::Serialize)]
/// struct ExampleResult {
/// text: String,
/// }
///
/// #[derive(serde::Serialize)]
/// struct Progress(f64);
///
/// // Note that the types of this function are very constrained:
/// // - `obj` must be an Arc<O> for some `Object` type.
/// // - `mth` must be Box<M> for some `Method` type.
/// // - `ctx` must be Box<dyn rpc::Context>.
/// // - The function must be async.
/// // - The return type must be a Result.
/// // - The OK variant of the result must M::Output.
/// // - The Err variant of the result must implement Into<rpc::RpcError>.
/// async fn example(obj: Arc<ExampleObject>,
/// method: Box<ExampleMethod>,
/// ctx: Box<dyn rpc::Context>,
/// ) -> Result<ExampleResult, rpc::RpcError> {
/// println!("Running example method!");
/// Ok(ExampleResult { text: "here is your result".into() })
/// }
///
/// rpc::static_rpc_invoke_fn!{example;}
///
/// // You can declare an example that produces updates as well:
/// // - The fourth argument must be `UpdateSink<M::Update>`.
/// async fn example2(obj: Arc<ExampleObject2>,
/// method: Box<ExampleMethod>,
/// ctx: Box<dyn rpc::Context>,
/// mut updates: rpc::UpdateSink<Progress>
/// ) -> Result<ExampleResult, rpc::RpcError> {
/// updates.send(Progress(0.90)).await?;
/// Ok(ExampleResult { text: "that was fast, wasn't it?".to_string() })
/// }
///
/// rpc::static_rpc_invoke_fn! {
/// example2;
/// }
/// ```
///
/// # Syntax:
///
/// ```rust,ignore
/// static_rpc_invoke_fn{
/// function; // zero or morea
/// ...
/// }
/// ```
///
/// where `function` is an expression referring to a static fn item,
/// with all necessary generics.
#[macro_export]
macro_rules! static_rpc_invoke_fn {
{
$( $func:expr; )*
} => {$crate::paste::paste!{ $(
$crate::inventory::submit!{
$crate::invoker_ent!($func)
}
)* }};
}
/// Obtain `&'static dyn `[`Invocable`] for a fn item
///
/// Given the name of a suitable fn item with all necessary generics,
/// expands to an expression for it of type `&'static dyn Invocable`.
#[doc(hidden)]
#[macro_export]
macro_rules! invocable_func_as_dyn_invocable { { $f:expr } => { {
let f = &($f as _);
// We want ^ this `as _ ` cast to convert the fn item (as a value
// of its unique unnameable type) to a value of type `fn(..) -> _`.
// We're not allowed to write `fn(..) -> _`, though.
//
// So: we cast it to `_`, and then arrange for the type inference to have to unify
// the `_` with the appropriate fn type, which we obtain through further trickery.
if false {
// Putting `*f` and the return value from `panic_returning_fn_type_for`
// into the same array means that they must have the same type.
// Ie type inference can see they must be the same type.
//
// We would have preferred to write, above, something like
// let f = $f as <$f as FnTypeOfFnTrait>::FnType;
// but the compiler refuses to let us treat the name of the fn item as a type name.
//
// We evade this problem by passing `$f` to a function that expects
// an impl `FnTypeOfFnTrait` and pretends that it would return the `fn` type.
let _: [_; 2] = [*f, $crate::dispatch::panic_returning_fn_type_for($f)];
}
// So, because of all the above, f is of type `fn(..) -> _`, which implements `Invocable`
// (assuming the fn item has the right signature). So we can cast it to dyn.
f as &'static dyn $crate::dispatch::Invocable
} } }
/// Helper trait for obtaining (at the type level) `fn` type from an `impl Fn`
///
/// Implemented for all types that implement `Fn`, up to and including 6 arguments.
/// (We only use the arities 3 and 4 right now.)
#[doc(hidden)]
pub trait FnTypeOfFnTrait<X> {
/// The `fn` type with the same arguments and return type.
type FnType;
}
/// Provide a blanket implementation of [`FnTypeOfFnTrait`] for some specific arity.
#[doc(hidden)]
macro_rules! impl_fn_type_of_fn_trait { { $($arg:ident)* } => {
impl<Func, Ret, $($arg),*> FnTypeOfFnTrait<(Ret, $($arg),*)> for Func
where Func: Fn($($arg),*) -> Ret {
type FnType = fn($($arg),*) -> Ret;
}
} }
impl_fn_type_of_fn_trait!();
impl_fn_type_of_fn_trait!(A);
impl_fn_type_of_fn_trait!(A B);
impl_fn_type_of_fn_trait!(A B C);
impl_fn_type_of_fn_trait!(A B C D);
impl_fn_type_of_fn_trait!(A B C D E);
impl_fn_type_of_fn_trait!(A B C D E F);
/// Pretend to return a value of type `fn..` corresponding to an `impl Fn`
///
/// Given a function implemneting `FnTypeOfFnTrait`, ie, any `Fn` closure,
/// pretends that it would return a value of the corresponding `fn` type.
///
/// Doesn't actually return a value (since that would be impossible);
/// if this is actually executed, it panics. So we don't execute it.
///
/// Instead we use the type of its mythical return value, in a non-taken branch,
/// to drive type inference.
#[doc(hidden)]
pub const fn panic_returning_fn_type_for<X, F: FnTypeOfFnTrait<X>>(_: F) -> F::FnType {
panic!()
}
/// Actual types to use when looking up a function in our HashMap.
#[derive(Eq, PartialEq, Clone, Debug, Hash)]
struct FuncType {
/// The type of object to which this function applies.
obj_id: any::TypeId,
/// The type of method to which this function applies.
method_id: any::TypeId,
}
/// A collection of method implementations for different method and object types.
///
/// A DispatchTable is constructed at run-time from entries registered with
/// [`static_rpc_invoke_fn!`].
///
/// There is one for each `arti-rpcserver::RpcMgr`, shared with each `arti-rpcserver::Connection`.
#[derive(Debug, Clone)]
pub struct DispatchTable {
/// An internal HashMap used to look up the correct function for a given
/// method/object pair.
map: HashMap<FuncType, InvokerEnt>,
}
impl DispatchTable {
/// Construct a `DispatchTable` from the entries registered statically via
/// [`static_rpc_invoke_fn!`].
///
/// # Panics
///
/// Panics if two entries are found for the same (method,object) types.
pub fn from_inventory() -> Self {
// We want to assert that there are no duplicates, so we can't use "collect"
let mut this = Self {
map: HashMap::new(),
};
for ent in inventory::iter::<InvokerEnt>() {
let old_val = this.insert_inner(*ent);
if old_val.is_some() {
panic!("Tried to insert duplicate entry for {:?}", ent);
}
}
this
}
/// Add a new entry to this DispatchTable, and return the old value if any.
fn insert_inner(&mut self, ent: InvokerEnt) -> Option<InvokerEnt> {
self.map.insert(
FuncType {
obj_id: ent.invoker.object_type(),
method_id: ent.invoker.method_type(),
},
ent,
)
}
/// Add a new entry to this DispatchTable.
///
/// # Panics
///
/// Panics if there was a previous entry inserted with the same (Object,Method) pair,
/// but (apparently) with a different implementation function, or from a macro invocation.
pub fn insert(&mut self, ent: InvokerEnt) {
if let Some(old_ent) = self.insert_inner(ent) {
// This is not a perfect check by any means; see `same_decl`.
assert!(old_ent.same_decl(&ent));
}
}
/// Try to find an appropriate function for calling a given RPC method on a
/// given RPC-visible object.
///
/// On success, return a Future.
pub fn invoke(
&self,
obj: Arc<dyn Object>,
method: Box<dyn DynMethod>,
ctx: Box<dyn Context>,
sink: BoxedUpdateSink,
) -> Result<RpcResultFuture, InvokeError> {
let func_type = FuncType {
obj_id: obj.type_id(),
method_id: method.type_id(),
};
let func = self.map.get(&func_type).ok_or(InvokeError::NoImpl)?;
func.invoker.invoke(obj, method, ctx, sink)
}
}
/// An error that occurred while trying to invoke a method on an object.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum InvokeError {
/// There is no implementation for the given combination of object
/// type and method type.
#[error("No implementation for provided object and method types.")]
NoImpl,
/// An internal problem occurred while invoking a method.
#[error("Internal error")]
Bug(#[from] tor_error::Bug),
}
#[cfg(test)]
mod test {
// @@ begin test lint list maintained by maint/add_warning @@
#![allow(clippy::bool_assert_comparison)]
#![allow(clippy::clone_on_copy)]
#![allow(clippy::dbg_macro)]
#![allow(clippy::mixed_attributes_style)]
#![allow(clippy::print_stderr)]
#![allow(clippy::print_stdout)]
#![allow(clippy::single_char_pattern)]
#![allow(clippy::unwrap_used)]
#![allow(clippy::unchecked_duration_subtraction)]
#![allow(clippy::useless_vec)]
#![allow(clippy::needless_pass_by_value)]
//! <!-- @@ end test lint list maintained by maint/add_warning @@ -->
use crate::{templates::*, Method, NoUpdates};
use derive_deftly::Deftly;
use futures::SinkExt;
use futures_await_test::async_test;
use std::sync::Arc;
use super::UpdateSink;
// Define 3 animals and one brick.
#[derive(Clone, Deftly)]
#[derive_deftly(Object)]
struct Swan;
#[derive(Clone, Deftly)]
#[derive_deftly(Object)]
struct Wombat;
#[derive(Clone, Deftly)]
#[derive_deftly(Object)]
struct Sheep;
#[derive(Clone, Deftly)]
#[derive_deftly(Object)]
struct Brick;
// Define 2 methods.
#[derive(Debug, serde::Deserialize, Deftly)]
#[derive_deftly(DynMethod)]
#[deftly(rpc(method_name = "x-test:getname"))]
struct GetName;
#[derive(Debug, serde::Deserialize, Deftly)]
#[derive_deftly(DynMethod)]
#[deftly(rpc(method_name = "x-test:getkids"))]
struct GetKids;
impl Method for GetName {
type Output = Outcome;
type Update = NoUpdates;
}
impl Method for GetKids {
type Output = Outcome;
type Update = String;
}
#[derive(serde::Serialize)]
struct Outcome {
v: String,
}
async fn getname_swan(
_obj: Arc<Swan>,
_method: Box<GetName>,
_ctx: Box<dyn crate::Context>,
) -> Result<Outcome, crate::RpcError> {
Ok(Outcome {
v: "swan".to_string(),
})
}
async fn getname_sheep(
_obj: Arc<Sheep>,
_method: Box<GetName>,
_ctx: Box<dyn crate::Context>,
) -> Result<Outcome, crate::RpcError> {
Ok(Outcome {
v: "sheep".to_string(),
})
}
async fn getname_wombat(
_obj: Arc<Wombat>,
_method: Box<GetName>,
_ctx: Box<dyn crate::Context>,
) -> Result<Outcome, crate::RpcError> {
Ok(Outcome {
v: "wombat".to_string(),
})
}
async fn getname_brick(
_obj: Arc<Brick>,
_method: Box<GetName>,
_ctx: Box<dyn crate::Context>,
) -> Result<Outcome, crate::RpcError> {
Ok(Outcome {
v: "brick".to_string(),
})
}
async fn getkids_swan(
_obj: Arc<Swan>,
_method: Box<GetKids>,
_ctx: Box<dyn crate::Context>,
) -> Result<Outcome, crate::RpcError> {
Ok(Outcome {
v: "cygnets".to_string(),
})
}
async fn getkids_sheep(
_obj: Arc<Sheep>,
_method: Box<GetKids>,
_ctx: Box<dyn crate::Context>,
) -> Result<Outcome, crate::RpcError> {
Ok(Outcome {
v: "lambs".to_string(),
})
}
async fn getkids_wombat(
_obj: Arc<Wombat>,
_method: Box<GetKids>,
_ctx: Box<dyn crate::Context>,
mut sink: UpdateSink<String>,
) -> Result<Outcome, crate::RpcError> {
let _ignore = sink.send("brb, burrowing".to_string()).await;
Ok(Outcome {
v: "joeys".to_string(),
})
}
static_rpc_invoke_fn! {
getname_swan;
getname_sheep;
getname_wombat;
getname_brick;
getkids_swan;
getkids_sheep;
getkids_wombat;
}
struct Ctx {}
impl crate::Context for Ctx {
fn lookup_object(
&self,
_id: &crate::ObjectId,
) -> Result<std::sync::Arc<dyn crate::Object>, crate::LookupError> {
todo!()
}
fn register_owned(&self, _object: Arc<dyn crate::Object>) -> crate::ObjectId {
todo!()
}
fn register_weak(&self, _object: Arc<dyn crate::Object>) -> crate::ObjectId {
todo!()
}
fn release_owned(&self, _object: &crate::ObjectId) -> Result<(), crate::LookupError> {
todo!()
}
}
#[derive(Deftly, Clone)]
#[derive_deftly(Object)]
struct GenericObj<T, U>
where
T: Send + Sync + 'static + Clone + ToString,
U: Send + Sync + 'static + Clone + ToString,
{
name: T,
kids: U,
}
async fn getname_generic<T, U>(
obj: Arc<GenericObj<T, U>>,
_method: Box<GetName>,
_ctx: Box<dyn crate::Context>,
) -> Result<Outcome, crate::RpcError>
where
T: Send + Sync + 'static + Clone + ToString,
U: Send + Sync + 'static + Clone + ToString,
{
Ok(Outcome {
v: obj.name.to_string(),
})
}
async fn getkids_generic<T, U>(
obj: Arc<GenericObj<T, U>>,
_method: Box<GetKids>,
_ctx: Box<dyn crate::Context>,
) -> Result<Outcome, crate::RpcError>
where
T: Send + Sync + 'static + Clone + ToString,
U: Send + Sync + 'static + Clone + ToString,
{
Ok(Outcome {
v: obj.kids.to_string(),
})
}
// We can also install specific instantiations statically.
static_rpc_invoke_fn! {
getname_generic::<u32,u32>;
getname_generic::<&'static str, &'static str>;
getkids_generic::<u32,u32>;
getkids_generic::<&'static str, &'static str>;
}
// And we can make code to install them dynamically too.
impl<T, U> GenericObj<T, U>
where
T: Send + Sync + 'static + Clone + ToString,
U: Send + Sync + 'static + Clone + ToString,
{
fn install_rpc_functions(table: &mut super::DispatchTable) {
table.insert(invoker_ent!(getname_generic::<T, U>));
table.insert(invoker_ent!(getkids_generic::<T, U>));
}
}
#[async_test]
async fn try_invoke() {
use super::*;
fn invoke_helper<O: Object, M: Method>(
table: &DispatchTable,
obj: O,
method: M,
) -> Result<RpcResultFuture, InvokeError> {
let animal: Arc<dyn crate::Object> = Arc::new(obj);
let request: Box<dyn DynMethod> = Box::new(method);
let ctx = Box::new(Ctx {});
let discard = Box::pin(futures::sink::drain().sink_err_into());
table.invoke(animal, request, ctx, discard)
}
async fn invoke_ok<O: crate::Object, M: crate::Method>(
table: &DispatchTable,
obj: O,
method: M,
) -> String {
let res = invoke_helper(table, obj, method).unwrap().await.unwrap();
serde_json::to_string(&res).unwrap()
}
async fn sentence<O: crate::Object + Clone>(table: &DispatchTable, obj: O) -> String {
format!(
"Hello I am a friendly {} and these are my lovely {}.",
invoke_ok(table, obj.clone(), GetName).await,
invoke_ok(table, obj, GetKids).await
)
}
let table = DispatchTable::from_inventory();
assert_eq!(
sentence(&table, Swan).await,
r#"Hello I am a friendly {"v":"swan"} and these are my lovely {"v":"cygnets"}."#
);
assert_eq!(
sentence(&table, Sheep).await,
r#"Hello I am a friendly {"v":"sheep"} and these are my lovely {"v":"lambs"}."#
);
assert_eq!(
sentence(&table, Wombat).await,
r#"Hello I am a friendly {"v":"wombat"} and these are my lovely {"v":"joeys"}."#
);
assert!(matches!(
invoke_helper(&table, Brick, GetKids),
Err(InvokeError::NoImpl)
));
/*
install_generic_fns::<&'static str, &'static str>(&mut table);
install_generic_fns::<u32, u32>(&mut table);
*/
let obj1 = GenericObj {
name: "nuncle",
kids: "niblings",
};
let obj2 = GenericObj {
name: 1337_u32,
kids: 271828_u32,
};
assert_eq!(
sentence(&table, obj1).await,
r#"Hello I am a friendly {"v":"nuncle"} and these are my lovely {"v":"niblings"}."#
);
assert_eq!(
sentence(&table, obj2).await,
r#"Hello I am a friendly {"v":"1337"} and these are my lovely {"v":"271828"}."#
);
let obj3 = GenericObj {
name: 13371337_u64,
kids: 2718281828_u64,
};
assert!(matches!(
invoke_helper(&table, obj3.clone(), GetKids),
Err(InvokeError::NoImpl)
));
let mut table = table;
GenericObj::<u64, u64>::install_rpc_functions(&mut table);
assert_eq!(
sentence(&table, obj3).await,
r#"Hello I am a friendly {"v":"13371337"} and these are my lovely {"v":"2718281828"}."#
);
}
}