Skip to main content

WindowDescriptor

Struct WindowDescriptor 

Source
pub struct WindowDescriptor {
    pub start_slot: u32,
    pub tenant_id: u32,
    pub opcode: SlotOpcode,
    pub ticket: u32,
    pub required: Vec<Vec<u32>>,
    pub lookahead: Vec<Vec<u32>>,
}
Expand description

A ticketed window of related slot publications.

Each emitted slot receives a stable prefix of [window_ticket, class_tag] followed by the caller-supplied payload, so wrappers can submit required and lookahead work as one structured batch without hand-assembling the prefix.

Fields§

§start_slot: u32

Slot index where the first window item should be written.

§tenant_id: u32

Tenant id used for all emitted slots.

§opcode: SlotOpcode

Slot opcode shared by all emitted slots.

§ticket: u32

Stable ticket id correlating every slot in this window.

§required: Vec<Vec<u32>>

Required entries for the window.

§lookahead: Vec<Vec<u32>>

Lookahead entries for the window.

Implementations§

Source§

impl WindowDescriptor

Source

pub fn new( start_slot: u32, tenant_id: u32, opcode: SlotOpcode, ticket: u32, required: Vec<Vec<u32>>, lookahead: Vec<Vec<u32>>, ) -> Self

Convenience constructor.

Source

pub fn into_batch(&self) -> BatchDescriptor

Convert the window into a typed batch publication.

Source

pub fn try_into_batch(&self) -> Result<BatchDescriptor, PipelineError>

Convert the window into a typed batch publication with explicit staging and ABI-bound errors.

Source

pub fn publish_into(&self, ring_bytes: &mut [u8]) -> Result<u32, PipelineError>

Publish the full window into the ring and return the number of emitted slots.

Trait Implementations§

Source§

impl Clone for WindowDescriptor

Source§

fn clone(&self) -> WindowDescriptor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for WindowDescriptor

Source§

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

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

impl Eq for WindowDescriptor

Source§

impl PartialEq for WindowDescriptor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for WindowDescriptor

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more