Struct Subscription 

pub struct Subscription { /* private fields */ }

Represents a registered subscription stored inside a context.

Implementations

impl Subscription

pub fn new( id: SubscriptionId, config: SubscriptionConfig, socket: Socket, ) -> Self

Creates a new subscription from an ID, configuration, and socket.

This is a low-level constructor. Callers are responsible for providing a socket that is compatible with the subscription configuration. For the checked convenience path, prefer Context::add_subscription_with_socket().

pub fn id(&self) -> SubscriptionId

Returns the subscription’s ID.

pub fn config(&self) -> &SubscriptionConfig

Returns a read-only reference to the subscription’s configuration.

pub fn socket(&self) -> &Socket

Returns a read-only reference to the subscription’s socket.

pub fn socket_mut(&mut self) -> &mut Socket

Returns a mutable reference to the subscription’s socket.

This is useful when an external event loop or registry needs mutable socket access during registration.

pub fn try_recv(&self) -> Result<Option<Packet>, McrxError>

Attempts to receive a single packet without blocking.

Returns:

• Ok(Some(packet)) if a packet was received,
• Ok(None) if no packet is currently available,
• Err(...) on an actual receive failure.

pub fn try_recv_with_metadata( &self, ) -> Result<Option<PacketWithMetadata>, McrxError>

Attempts to receive a single packet together with richer receive metadata without blocking.

pub fn as_raw_fd(&self) -> RawFd

Returns the raw Unix file descriptor of the underlying socket.

This is useful for integrating subscriptions into external event loops.

pub fn local_addr(&self) -> Result<SocketAddr, McrxError>

Returns the local socket address currently bound by this subscription.

pub fn into_socket(self) -> Socket

Consumes the subscription and returns its owned socket.

This is useful when handing a joined or bound socket off to an external event loop or async runtime.

pub fn into_parts(self) -> SubscriptionParts

Consumes the subscription and returns all owned parts.

pub fn state(&self) -> SubscriptionState

Returns the current lifecycle state of the subscription.

This can be used by callers to inspect whether the subscription is currently joined to its multicast group or only bound.

pub fn is_joined(&self) -> bool

Returns true if the subscription is currently joined to its multicast group.

This is a convenience helper for checking whether the subscription is in the SubscriptionState::Joined state.

pub fn mark_joined(&mut self) -> Result<(), McrxError>

Marks the subscription as joined.

This should be called after a successful multicast join operation on the underlying socket.

Returns an error if the subscription is already in the joined state.

pub fn mark_bound(&mut self) -> Result<(), McrxError>

Marks the subscription as bound (not joined).

This should be called after leaving a multicast group, while keeping the underlying socket open and bound.

Returns an error if the subscription is already in the bound state.

Trait Implementations

impl AsFd for Subscription

Available on Unix only.

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for Subscription

Available on Unix only.

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for Subscription

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

Formats the value using the given formatter.