From b5b5e92863f5ddff07a8ff7a4935a2df92ae8cc1 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Fri, 23 Feb 2024 17:41:36 +0100 Subject: [PATCH] improve docs --- satrs/src/event_man.rs | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/satrs/src/event_man.rs b/satrs/src/event_man.rs index b0470dd..3441188 100644 --- a/satrs/src/event_man.rs +++ b/satrs/src/event_man.rs @@ -85,12 +85,8 @@ pub trait EventSendProvider { /// Generic abstraction for an event receiver. pub trait EventReceiveProvider { - /// This function has to be provided by any event receiver. A receive call may or may not return - /// an event. - /// - /// To allow returning arbitrary additional auxiliary data, a mutable slice is passed to the - /// [Self::receive] call as well. Receivers can write data to this slice, but care must be taken - /// to avoid panics due to size missmatches or out of bound writes. + /// This function has to be provided by any event receiver. A call may or may not return + /// an event and optional auxiliary data. fn try_recv_event(&self) -> Option<(Event, Option)>; }