Struct WeakClient

Source
pub struct WeakClient<S, R, E>(/* private fields */);
Expand description

A weak client reference that can be upgraded to a Client as long as other Client objects till exist.

Implementations§

Source§

impl<S, R, E> Weak<S, R, E>

Source

pub fn upgrade(&self) -> Option<Client<S, R, E>>

Upgrade a WeakClient to a Client.

If no strong Client objects still exist then None is returned.

§Examples

Upgrading a weak client while stong clients exists works:

use ump::{channel, Error};

let (server, client) = channel::<String, String, ()>();
let weak_client = client.weak();
let Some(client2) = weak_client.upgrade() else {
  panic!("Unable to upgrade weak client");
};

Upgrading a weak client when no stong clients exists fails:

use ump::{channel, Error};

let (server, client) = channel::<String, String, ()>();
let weak_client = client.weak();
drop(client);
let Some(_) = weak_client.upgrade() else {
  panic!("Unexpectedly able to upgrade weak client");
};

Trait Implementations§

Source§

impl<S, R, E> Clone for Weak<S, R, E>

Source§

fn clone(&self) -> Weak<S, R, E>

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<S, R, E> Freeze for Weak<S, R, E>

§

impl<S, R, E> !RefUnwindSafe for Weak<S, R, E>

§

impl<S, R, E> Send for Weak<S, R, E>
where S: Send, R: Send, E: Send,

§

impl<S, R, E> Sync for Weak<S, R, E>
where S: Send, R: Send, E: Send,

§

impl<S, R, E> Unpin for Weak<S, R, E>

§

impl<S, R, E> !UnwindSafe for Weak<S, R, E>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more