Skip to main content

EdgeLink

Struct EdgeLink 

Source
#[non_exhaustive]
pub struct EdgeLink<Q>
where Q: Edge,
{ /* private fields */ }
Expand description

A lightweight descriptor that links to the concrete queue instance backing a graph edge, along with its routing and policy metadata.

Unlike a pure descriptor, EdgeLink owns the queue implementation. This keeps it zero-alloc and allows direct, policy-aware operations on the buffer.

  • Q: concrete queue type implementing Edge

Implementations§

Source§

impl<Q> EdgeLink<Q>
where Q: Edge,

Source

pub fn new( queue: Q, id: EdgeIndex, upstream_port: PortId, downstream_port: PortId, policy: EdgePolicy, name: Option<&'static str>, ) -> Self

Construct a new EdgeLink that owns the given queue and records its metadata.

Source

pub fn queue(&self) -> &Q

Get a reference to the inner queue.

Source

pub fn queue_mut(&mut self) -> &mut Q

Get a mutable reference to the inner queue.

Source

pub fn id(&self) -> &EdgeIndex

Get the unique identifier of this edge.

Source

pub fn upstream_port(&self) -> &PortId

Get the upstream output port index.

Source

pub fn downstream_port(&self) -> &PortId

Get the downstream input port index.

Source

pub fn policy(&self) -> &EdgePolicy

Get the edge policy applied to this queue.

Source

pub fn name(&self) -> Option<&'static str>

Get the optional static name of this queue link.

Source

pub fn descriptor(&self) -> EdgeDescriptor

Return the EdgeDescriptor for this EdgeLink.

Trait Implementations§

Source§

impl<Q> Debug for EdgeLink<Q>
where Q: Edge + Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<Q> Edge for EdgeLink<Q>
where Q: Edge,

Source§

fn try_push<H: HeaderStore>( &mut self, token: MessageToken, policy: &EdgePolicy, headers: &H, ) -> EnqueueResult

Attempt to push a token onto the queue using the given edge policy. Read more
Source§

fn try_pop<H: HeaderStore>( &mut self, headers: &H, ) -> Result<MessageToken, QueueError>

Attempt to pop the front token from the queue. Read more
Source§

fn occupancy(&self, policy: &EdgePolicy) -> EdgeOccupancy

Return a snapshot of occupancy used for telemetry and admission. Read more
Source§

fn is_empty(&self) -> bool

Return true if the queue is empty.
Source§

fn try_peek(&self) -> Result<MessageToken, QueueError>

Peek at the front token without removing it.
Source§

fn try_peek_at(&self, index: usize) -> Result<MessageToken, QueueError>

Peek at the token at logical position index from the front. Read more
Source§

fn try_pop_batch<H: HeaderStore>( &mut self, policy: &BatchingPolicy, headers: &H, ) -> Result<BatchView<'_, MessageToken>, QueueError>

Pop a batch of tokens according to the provided batching policy. Read more
Source§

fn peek_header<'h, H: HeaderStore>( &self, headers: &'h H, ) -> Result<<H as HeaderStore>::HeaderGuard<'h>, QueueError>

Peek the front message header via HeaderStore (convenience). Read more
Source§

fn get_admission_decision<H: HeaderStore>( &self, policy: &EdgePolicy, token: MessageToken, headers: &H, ) -> AdmissionDecision

Return an AdmissionDecision for the given token according to policy and the current occupancy snapshot. Read more
Source§

fn get_admission_decision_from_message<P: Payload>( &self, policy: &EdgePolicy, message: &Message<P>, ) -> AdmissionDecision

Return an AdmissionDecision for the given token according to policy and the current occupancy snapshot. Read more

Auto Trait Implementations§

§

impl<Q> Freeze for EdgeLink<Q>
where Q: Freeze,

§

impl<Q> RefUnwindSafe for EdgeLink<Q>
where Q: RefUnwindSafe,

§

impl<Q> Send for EdgeLink<Q>
where Q: Send,

§

impl<Q> Sync for EdgeLink<Q>
where Q: Sync,

§

impl<Q> Unpin for EdgeLink<Q>
where Q: Unpin,

§

impl<Q> UnsafeUnpin for EdgeLink<Q>
where Q: UnsafeUnpin,

§

impl<Q> UnwindSafe for EdgeLink<Q>
where Q: UnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.