Nanaloveyuki/sync/channel

Nanaloveyuki/sync/channel does not have a README file

SyncError

using @Nanaloveyuki/sync/types { type SyncError }

OwnedBytesReceiver

source

pub struct OwnedBytesReceiver {
  // private fields
}

A single-consumer endpoint for an owned-bytes channel.

Received values are newly allocated on the receiving thread. They do not alias the Bytes value supplied by the sender.

OwnedBytesReceiver::capacity

source

fn OwnedBytesReceiver::capacity(self : OwnedBytesReceiver) -> Int

Returns the fixed message capacity.

OwnedBytesReceiver::close

source

fn OwnedBytesReceiver::close(self : OwnedBytesReceiver) -> Unit raise @Nanaloveyuki/sync/types.SyncError
SyncError

Idempotently closes the channel and wakes blocked endpoints.

OwnedBytesReceiver::length

source

fn OwnedBytesReceiver::length(self : OwnedBytesReceiver) -> Int raise @Nanaloveyuki/sync/types.SyncError
SyncError

Returns the number of copied messages waiting to be received.

OwnedBytesReceiver::recv

source

fn OwnedBytesReceiver::recv(self : OwnedBytesReceiver) -> Bytes? raise @Nanaloveyuki/sync/types.SyncError
SyncError

Blocks for a copied message, returning None after closure and queue drain.

OwnedBytesReceiver::try_recv

source

fn OwnedBytesReceiver::try_recv(self : OwnedBytesReceiver) -> OwnedBytesTryRecvResult raise @Nanaloveyuki/sync/types.SyncError
SyncError

Attempts to receive without blocking.

OwnedBytesSendResult

source

pub(all) enum OwnedBytesSendResult {
  Sent
  MessageTooLarge(Int, Int)
  Closed
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The result of a blocking owned-bytes send.

OwnedBytesSender

source

pub struct OwnedBytesSender {
  // private fields
}

A producer endpoint for an owned-bytes channel.

send copies the bytes into native-owned storage before it returns. The channel never retains a MoonBit heap object from the sending thread.

OwnedBytesSender::close

source

fn OwnedBytesSender::close(self : OwnedBytesSender) -> Unit raise @Nanaloveyuki/sync/types.SyncError
SyncError

Idempotently closes the channel and wakes blocked endpoints.

OwnedBytesSender::send

source

fn OwnedBytesSender::send(self : OwnedBytesSender, message : Bytes) -> Bool raise @Nanaloveyuki/sync/types.SyncError
SyncError

Blocks until bytes are copied into the queue or the channel closes.

Returns false when the channel closes or rejects an oversized message. Use send_checked when the caller must distinguish these outcomes.

OwnedBytesSender::send_checked

source

fn OwnedBytesSender::send_checked(self : OwnedBytesSender, message : Bytes) -> OwnedBytesSendResult raise @Nanaloveyuki/sync/types.SyncError
SyncError

Blocks until bytes are copied into the queue, the channel closes, or the message exceeds its configured byte limit.

fn OwnedBytesSender::share(self : OwnedBytesSender) -> OwnedBytesSender raise @Nanaloveyuki/sync/types.SyncError
SyncError

Creates an independent producer wrapper for a different OS thread.

OwnedBytesSender::try_send

source

fn OwnedBytesSender::try_send(self : OwnedBytesSender, message : Bytes) -> OwnedBytesTrySendResult raise @Nanaloveyuki/sync/types.SyncError
SyncError

Attempts to copy and enqueue bytes without blocking.

OwnedBytesTryRecvResult

source

pub(all) enum OwnedBytesTryRecvResult {
  Received(Bytes)
  Empty
  Closed
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The result of a non-blocking owned-bytes receive.

OwnedBytesTrySendResult

source

pub(all) enum OwnedBytesTrySendResult {
  Sent
  Full
  QueueByteLimitReached(Int, Int)
  MessageTooLarge(Int, Int)
  Closed
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The result of a non-blocking owned-bytes send.

owned_bytes_bounded

source

fn owned_bytes_bounded(capacity : Int) -> (OwnedBytesSender, OwnedBytesReceiver) raise @Nanaloveyuki/sync/types.SyncError
SyncError

Creates a bounded channel with a 4 MiB per-message and 16 MiB total queue byte limit. Capacity must be greater than zero.

owned_bytes_bounded_with_limits

source

fn owned_bytes_bounded_with_limits(capacity : Int, max_message_bytes~ : Int, max_queued_bytes~ : Int) -> (OwnedBytesSender, OwnedBytesReceiver) raise @Nanaloveyuki/sync/types.SyncError
SyncError

Creates a bounded channel with explicit byte limits.

max_message_bytes rejects oversized messages before copying. The channel accepts at most max_queued_bytes of copied payloads at once, in addition to its message-count capacity.