Struct ChannelReceiver 

pub(crate) struct ChannelReceiver(pub(in core) GcHeap<ChannelReceiverInner>);

The receiving half of a channel.

Tuple Fields

0: GcHeap<ChannelReceiverInner>

Implementations

impl ChannelReceiver

pub(in core) fn new( channel_id: u64, manager: Arc<ChannelManager>, constant: bool, ) -> Self

pub(crate) fn recv<'ob>( &self, cx: &'ob Context<'_>, ) -> Result<Gc<ObjectType<'ob>>, RecvError>

Receive an object from the channel, blocking if empty. Returns Err(RecvError::Closed) if all senders have been dropped.

pub(crate) fn try_recv<'ob>( &self, cx: &'ob Context<'_>, ) -> Result<Gc<ObjectType<'ob>>, RecvError>

Try to receive without blocking. Returns Err(RecvError::Empty) if the channel is empty. Returns Err(RecvError::Closed) if all senders have been dropped.

pub(crate) fn recv_timeout<'ob>( &self, cx: &'ob Context<'_>, timeout: Duration, ) -> Result<Gc<ObjectType<'ob>>, RecvError>

Receive with a timeout. Returns Err(RecvError::Timeout) if the timeout expires. Returns Err(RecvError::Closed) if all senders have been dropped.

pub(crate) fn close(&self)

Explicitly close the receiver side of the channel. This wakes up any senders waiting on send() and causes them to return Err(SendError::Closed). This is idempotent - calling close() multiple times has no additional effect.

Useful for “moving” a receiver to another thread: the original receiver can be closed after being cloned into a new context.

Trait Implementations

impl<'new> CloneIn<'new, &'new ChannelReceiver> for ChannelReceiver

fn clone_in<const C: bool>(&self, _bk: &'new Block<C>) -> Gc<&'new Self>

impl Debug for ChannelReceiver

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ChannelReceiver

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'ob> From<&'ob ChannelReceiver> for Gc<ObjectType<'ob>>

fn from(x: &'ob ChannelReceiver) -> Self

Converts to this type from the input type.

impl GcMoveable for ChannelReceiver

type Value = NonNull<ChannelReceiver>

fn move_value(&self, to_space: &Bump) -> Option<(Self::Value, bool)>

impl IntoObject for ChannelReceiver

type Out<'ob> = &'ob ChannelReceiver

fn into_obj<const C: bool>(self, block: &Block<C>) -> Gc<Self::Out<'_>>

impl PartialEq for ChannelReceiver

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TaggedPtr for &ChannelReceiver

const TAG: Tag = Tag::ChannelReceiver

Tag value. This is only applicable to base values. Use Int for sum types.

type Ptr = ChannelReceiver

The type of object being pointed to. This will be different for all implementors.

unsafe fn from_obj_ptr(ptr: *const u8) -> Self

Given an untyped pointer, reinterpret to self.

fn get_ptr(self) -> *const Self::Ptr

Get the underlying pointer.

unsafe fn tag_ptr(ptr: *const Self::Ptr) -> Gc<Self>

Given a pointer to Ptr return a Tagged pointer.

fn untag(val: Gc<Self>) -> Self

Remove the tag from the Gc<T> and return the inner type. If it is base type then it will only have a single possible value and can be untagged without checks, but sum types need to create all values they can hold. We use tagged base types to let us reinterpret bits without actually modify them.

fn tag(self) -> Gc<Self>

Given the type, return a tagged version of it. When using a sum type or an immediate value like i64, we override this method to set the proper tag.

impl<'old, 'new> WithLifetime<'new> for &'old ChannelReceiver

type Out = &'new ChannelReceiver

unsafe fn with_lifetime(self) -> Self::Out

impl Eq for ChannelReceiver

impl GcPtr for &ChannelReceiver