Struct ChannelSender 

pub(crate) struct ChannelSender(pub(in core) GcHeap<ChannelSenderInner>);

The sending half of a channel.

Tuple Fields

0: GcHeap<ChannelSenderInner>

Implementations

impl ChannelSender

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

pub(crate) fn send<'ob>( &self, obj: Gc<ObjectType<'ob>>, ) -> Result<(), SendError>

Send an object through the channel, blocking if full. Returns Err(SendError::Closed) if the receiver has been dropped.

pub(crate) fn try_send<'ob>( &self, obj: Gc<ObjectType<'ob>>, ) -> Result<(), SendError>

Try to send without blocking. Returns Err(SendError::Full) if the channel is full. Returns Err(SendError::Closed) if the receiver has been dropped.

pub(crate) fn send_timeout<'ob>( &self, obj: Gc<ObjectType<'ob>>, timeout: Duration, ) -> Result<(), SendError>

Send with a timeout. Returns Err(SendError::Timeout) if the timeout expires. Returns Err(SendError::Closed) if the receiver has been dropped.

pub(crate) fn close(&self)

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

Trait Implementations

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

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

impl Debug for ChannelSender

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

Formats the value using the given formatter.

impl Display for ChannelSender

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl GcMoveable for ChannelSender

type Value = NonNull<ChannelSender>

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

impl IntoObject for ChannelSender

type Out<'ob> = &'ob ChannelSender

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

impl PartialEq for ChannelSender

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 &ChannelSender

const TAG: Tag = Tag::ChannelSender

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

type Ptr = ChannelSender

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 ChannelSender

type Out = &'new ChannelSender

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

impl Eq for ChannelSender

impl GcPtr for &ChannelSender