Skip to main content

OutputSample

Struct OutputSample 

Source
pub struct OutputSample<'a> { /* private fields */ }
Expand description

A reserved write buffer for one message.

Implementations§

Source§

impl<'a> OutputSample<'a>

Source

pub fn shm( window: SampleMut<'a>, shared: Arc<SessionShared>, output: DataId, segment: Option<(String, u64)>, ) -> Self

A sample backed by a ring slot.

Source

pub fn heap(bytes: Vec<u8>, shared: Arc<SessionShared>, output: DataId) -> Self

A sample backed by an owned heap buffer.

Source

pub const fn is_zero_copy(&self) -> bool

Whether writing here copies nothing.

Source

pub fn len(&self) -> usize

The buffer’s length in bytes.

Source

pub fn is_empty(&self) -> bool

Whether the buffer is empty.

Source

pub fn as_mut_slice(&mut self) -> &mut [u8] ⓘ

The writable bytes.

On the zero-copy plane the slice base is 128-byte aligned (§6.1), so an Arrow IPC message serialised straight into it is directly usable as a SIMD source by every consumer.

Source

pub fn as_slice(&self) -> &[u8] ⓘ

The bytes written so far.

Source

pub const fn output(&self) -> &DataId

The output this sample belongs to.

Source

pub fn sequence(&self) -> Option<u64>

The sequence number this window will publish, on the zero-copy plane.

Source

pub fn truncate(&mut self, len: usize) -> Result<()>

Shortens the buffer to len bytes.

The encoder that reserved a generous window and produced less keeps the zero-copy path rather than falling back to a copy.

§Errors

crate::NodeError::Shm when len is longer than the window.

Source

pub fn send(self, metadata: Metadata) -> Result<()>

Publishes the message.

§Errors

crate::NodeError::DaemonGone once the session has ended, and crate::NodeError::Wire when the metadata cannot be encoded.

Source

pub fn abort(self)

Discards the reservation.

A ring slot returns to the pool without consuming its sequence number.

Trait Implementations§

Source§

impl<'a> Debug for OutputSample<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> !UnwindSafe for OutputSample<'a>

§

impl<'a> Freeze for OutputSample<'a>

§

impl<'a> RefUnwindSafe for OutputSample<'a>

§

impl<'a> Send for OutputSample<'a>

§

impl<'a> Sync for OutputSample<'a>

§

impl<'a> Unpin for OutputSample<'a>

§

impl<'a> UnsafeUnpin for OutputSample<'a>

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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