pub struct StreamInput { /* private fields */ }
Expand description

Stream input port

Implementations§

source§

impl StreamInput

source

pub fn new<T: Any>(name: &str) -> StreamInput

Create stream input with given name

source

pub fn item_size(&self) -> usize

Get size of items, handled by the port

source

pub fn type_id(&self) -> TypeId

Get TypeId of items, handled by the port

source

pub fn name(&self) -> &str

Get name of port

source

pub fn try_as<T: 'static>(&mut self) -> Option<&mut T>

Try to cast buffer reader to specific type

source

pub fn consume(&mut self, amount: usize)

Consume amount samples from buffer

source

pub fn slice<T>(&mut self) -> &'static [T]

Get buffer content as slice

source

pub fn slice_unchecked<T>(&mut self) -> &'static [T]

Get buffer content as slice without checking the type

source

pub unsafe fn slice_mut<T>(&mut self) -> &'static mut [T]

Returns a mutable slice to the input buffer.

Safety

The block has to be the sole reader for the input buffer.

source

pub unsafe fn slice_mut_unchecked<T>(&mut self) -> &'static mut [T]

Returns a mutable slice to the input buffer.

Safety

The block has to be the sole reader for the input buffer.

source

pub fn tags(&mut self) -> &mut Vec<ItemTag>

Get ItemTags in buffer

source

pub fn consumed(&self) -> (usize, &Vec<ItemTag>)

Items already consumed in this call to work

source

pub fn set_reader(&mut self, reader: BufferReader)

Set the buffer reader

source

pub async fn notify_finished(&mut self)

Notify connected, upstream writer that we are finished

source

pub fn finish(&mut self)

Mark port as finished

No further data will become available in this port.

source

pub fn finished(&self) -> bool

Check, if port is marked as finished

Trait Implementations§

source§

impl Debug for StreamInput

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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.

§

impl<T> Instrument for T

§

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

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

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

§

type Output = T

Should always be Self
source§

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

§

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 Twhere U: TryFrom<T>,

§

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

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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