Skip to main content

Batch

Struct Batch 

Source
pub struct Batch<'a, P: Payload> { /* private fields */ }
Expand description

A thin batch view over a slice of messages.

Batch formation is runtime-specific; the core only provides a convenient immutable view for policies and telemetry.

Implementations§

Source§

impl<'a, P: Payload> Batch<'a, P>

Source

pub const fn new(messages: &'a [Message<P>]) -> Self

Construct a new batch view over a slice of messages.

Source

pub fn messages(&self) -> &'a [Message<P>]

Return the underlying messages slice.

Source

pub fn len(&self) -> usize

Return the number of messages in the batch.

Source

pub fn is_empty(&self) -> bool

Return true if the batch is empty.

Source

pub fn total_payload_bytes(&self) -> usize

Total byte size across message payloads.

Source

pub fn iter(&self) -> Iter<'_, Message<P>>

Iterate over messages.

Source

pub fn first_flagged(&self) -> bool

Convenience: is the first message marked FIRST_IN_BATCH (if present)?

Source

pub fn last_flagged(&self) -> bool

Convenience: is the last message marked LAST_IN_BATCH (if present)?

Source

pub fn assert_flags_consistent(&self)

(Optional) Validate flags are consistent with batch boundaries. Enable only when you want assertions (e.g., in tests) via a feature flag.

Trait Implementations§

Source§

impl<'a, P: Clone + Payload> Clone for Batch<'a, P>

Source§

fn clone(&self) -> Batch<'a, P>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a, P: Debug + Payload> Debug for Batch<'a, P>

Source§

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

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

impl<'a, P: Payload> Payload for &'a Batch<'a, P>

Source§

fn buffer_descriptor(&self) -> BufferDescriptor

Return a descriptor containing the byte size of this payload.
Source§

impl<'a, P: Payload> Payload for Batch<'a, P>

Source§

fn buffer_descriptor(&self) -> BufferDescriptor

Return a descriptor containing the byte size of this payload.
Source§

impl<'a, P: Copy + Payload> Copy for Batch<'a, P>

Auto Trait Implementations§

§

impl<'a, P> Freeze for Batch<'a, P>

§

impl<'a, P> RefUnwindSafe for Batch<'a, P>
where P: RefUnwindSafe,

§

impl<'a, P> Send for Batch<'a, P>
where P: Sync,

§

impl<'a, P> Sync for Batch<'a, P>
where P: Sync,

§

impl<'a, P> Unpin for Batch<'a, P>

§

impl<'a, P> UnsafeUnpin for Batch<'a, P>

§

impl<'a, P> UnwindSafe for Batch<'a, P>
where P: RefUnwindSafe,

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