Struct SignalFuture
pub struct SignalFuture<R>(/* private fields */)
where
R: InParamTuple + IntoDynamicSend;Expand description
The panicking counter part to the FallibleSignalFuture.
This future works in the same way as FallibleSignalFuture, but panics when the signal object is freed, instead of resolving to a
Result::Err.
§Panics
- If the signal object is freed before the signal has been emitted.
- If one of the signal arguments is
!Send, but the signal was emitted on a different thread.
§Keeping the signal object alive
If the signal object is freed concurrently while the future is being dropped, connection cleanup is skipped and the stale connection is
leaked (Godot removes it once the object dies), rather than aborting the process. This is only reachable by moving a Gd across threads,
which requires unsafe (Gd is !Send); in safe, single-threaded code it cannot happen. If you do bypass !Send, it is your
responsibility to keep the object alive – retain a strong Gd on the runtime thread, or join() the other thread – until no pending
future refers to it.
Trait Implementations§
§impl<R> Future for SignalFuture<R>where
R: InParamTuple + IntoDynamicSend,
impl<R> Future for SignalFuture<R>where
R: InParamTuple + IntoDynamicSend,
§fn poll(
self: Pin<&mut SignalFuture<R>>,
cx: &mut Context<'_>,
) -> Poll<<SignalFuture<R> as Future>::Output>
fn poll( self: Pin<&mut SignalFuture<R>>, cx: &mut Context<'_>, ) -> Poll<<SignalFuture<R> as Future>::Output>
Attempts to resolve the future to a final value, registering
the current task for wakeup if the value is not yet available. Read more
Auto Trait Implementations§
impl<R> Freeze for SignalFuture<R>
impl<R> RefUnwindSafe for SignalFuture<R>
impl<R> !Send for SignalFuture<R>
impl<R> !Sync for SignalFuture<R>
impl<R> Unpin for SignalFuture<R>
impl<R> UnsafeUnpin for SignalFuture<R>
impl<R> UnwindSafe for SignalFuture<R>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<F> IntoFuture for Fwhere
F: Future,
impl<F> IntoFuture for Fwhere
F: Future,
Source§type IntoFuture = F
type IntoFuture = F
Which kind of future are we turning this into?
Source§fn into_future(self) -> <F as IntoFuture>::IntoFuture
fn into_future(self) -> <F as IntoFuture>::IntoFuture
Creates a future from a value. Read more