Struct rotary::io::Read

pub struct Read<B> { /* fields omitted */ }

Make a buffer into a read adapter that implements ReadBuf.

Examples

use rotary::{Buf as _, BufMut as _, WriteBuf as _};
use rotary::io;

let from = rotary::interleaved![[1.0f32, 2.0f32, 3.0f32, 4.0f32]; 2];
let mut to = rotary::interleaved![[0.0f32; 4]; 2];

let mut to = io::ReadWrite::new(to);

io::copy_remaining(io::Read::new((&from).skip(2).limit(1)), &mut to);
io::copy_remaining(io::Read::new((&from).limit(1)), &mut to);

assert_eq! {
    to.as_ref().as_slice(),
    &[3.0, 3.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0],
};

Implementations

impl<B> Read<B> where
    B: ExactSizeBuf, 

pub fn new(buf: B) -> Self

Construct a new read adapter.

pub fn as_ref(&self) -> &B

Access the underlying buffer.

Examples

use rotary::{Buf as _, WriteBuf as _};
use rotary::{io, wrap};

let buffer: rotary::Interleaved<i16> = rotary::interleaved![[1, 2, 3, 4]; 4];
let mut buffer = io::Read::new(buffer);

io::copy_remaining(&mut buffer, wrap::interleaved(&mut [0i16; 16][..], 4));

assert_eq!(buffer.as_ref().channels(), 4);

pub fn as_mut(&mut self) -> &mut B

Access the underlying buffer mutably.

Examples

use rotary::{Buf as _, WriteBuf as _, ExactSizeBuf as _};
use rotary::{io, wrap};

let buffer: rotary::Interleaved<i16> = rotary::interleaved![[1, 2, 3, 4]; 4];
let mut buffer = io::Read::new(buffer);

io::copy_remaining(&mut buffer, wrap::interleaved(&mut [0i16; 16][..], 4));

buffer.as_mut().resize_channels(2);

assert_eq!(buffer.channels(), 2);

pub fn into_inner(self) -> B

Convert into the underlying buffer.

Examples

use rotary::{Buf as _, WriteBuf as _};
use rotary::{io, wrap};

let buffer: rotary::Interleaved<i16> = rotary::interleaved![[1, 2, 3, 4]; 4];
let mut buffer = io::Read::new(buffer);

io::copy_remaining(&mut buffer, wrap::interleaved(&mut [0i16; 16][..], 4));

let buffer = buffer.into_inner();

assert_eq!(buffer.channels(), 4);

Trait Implementations

impl<B, T> Buf<T> for Read<B> where
    B: Buf<T>, 

fn frames_hint(&self) -> Option<usize>

A typical number of frames in the buffer, if known.

fn channels(&self) -> usize

The number of channels in the buffer.

fn channel(&self, channel: usize) -> Channel<'_, T>

Return a handler to the buffer associated with the channel.

pub fn skip(self, n: usize) -> Skip<Self>

Construct a new buffer where n frames are skipped.

pub fn tail(self, n: usize) -> Tail<Self>

Construct a new buffer where n frames are skipped.

pub fn limit(self, limit: usize) -> Limit<Self>

Limit the channel buffer to limit number of frames.

pub fn chunk(self, n: usize, len: usize) -> Chunk<Self>

Construct a range of frames corresponds to the chunk with len and position n.

impl<B> ExactSizeBuf for Read<B> where
    B: ExactSizeBuf, 

fn frames(&self) -> usize

The number of frames in a buffer.

impl<B> ReadBuf for Read<B>

fn remaining(&self) -> usize

Get the number of frames remaining that can be read from the buffer.

fn advance(&mut self, n: usize)

Advance the read number of frames by n.

pub fn has_remaining(&self) -> bool

Test if there are any remaining frames to read.