Struct rotary::io::Read

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

Make a buffer into a read adapter that implements ReadBuf.

Examples

use rotary::Buf;
use rotary::io;

let from = rotary::interleaved![[1, 2, 3, 4]; 2];
let mut to = rotary::interleaved![[0; 4]; 2];

let mut to = io::ReadWrite::empty(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, 3, 1, 1, 0, 0, 0, 0]);

Implementations

impl<B> Read<B>

pub fn new(buf: B) -> Self where
    B: ExactSizeBuf, 

Construct a new reading adapter.

The constructed reader will be initialized so that the number of bytes available for reading are equal to what’s reported by ExactSizeBuf::frames.

Examples

use rotary::{ReadBuf, ExactSizeBuf};
use rotary::io;

let buffer = rotary::interleaved![[1, 2, 3, 4], [5, 6, 7, 8]];
assert_eq!(buffer.frames(), 4);

let buffer = io::Read::new(buffer);

assert!(buffer.has_remaining());
assert_eq!(buffer.remaining(), 4);

pub fn empty(buf: B) -> Self

Construct a new reading adapter.

The constructed reader will be initialized so that there are no frames available for reading.

Examples

use rotary::{ReadBuf, ExactSizeBuf};
use rotary::io;

let buffer = rotary::interleaved![[1, 2, 3, 4], [5, 6, 7, 8]];
assert_eq!(buffer.frames(), 4);

let buffer = io::Read::empty(buffer);

assert!(!buffer.has_remaining());
assert_eq!(buffer.remaining(), 0);

pub fn as_ref(&self) -> &B

Access the underlying buffer.

Examples

use rotary::Buf;
use rotary::{io, wrap};

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

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

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

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

Access the underlying buffer mutably.

Examples

use rotary::Buf;
use rotary::{io, wrap};

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

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

from.as_mut().resize_channels(2);

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

pub fn into_inner(self) -> B

Convert into the underlying buffer.

Examples

use rotary::Buf;
use rotary::{io, wrap};

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

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

let from = from.into_inner();

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

pub fn set_read(&mut self, read: usize) where
    B: ExactSizeBuf, 

Set the number of frames read.

This can be used to rewind the internal cursor to a previously written frame if needed. Or, if the underlying buffer has changed for some reason, like if it was written to through a call to Read::as_mut.

Examples

use rotary::{Buf, Channels, ReadBuf};
use rotary::io;

fn read_from_buf(mut read: impl Buf + Channels<i16> + ReadBuf) {
    let mut out = rotary::interleaved![[0; 4]; 2];
    io::copy_remaining(read, io::Write::new(&mut out));
}

let mut buffer = io::Read::new(rotary::interleaved![[1, 2, 3, 4], [5, 6, 7, 8]]);
read_from_buf(&mut buffer);

assert!(!buffer.has_remaining());

buffer.set_read(0);

assert!(buffer.has_remaining());

Trait Implementations

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

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

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

fn channels(&self) -> usize

The number of channels in the buffer.

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, T> Channels<T> for Read<B> where
    B: Channels<T>, 

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

Return a handler to the buffer associated with the channel.

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.