Struct rotary::io::Write

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

Make a mutable buffer into a write adapter that implements WriteBuf.

Examples

use rotary::{Buf as _, BufMut as _, ReadBuf as _, WriteBuf as _};
use rotary::io::{Read, Write, copy_remaining};

let from = rotary::interleaved![[1.0f32, 2.0f32, 3.0f32, 4.0f32]; 2];
let to = rotary::interleaved![[0.0f32; 4]; 2];
let mut to = Write::new(to);
let mut from = Read::new(from.skip(2));

assert_eq!(to.remaining_mut(), 4);
copy_remaining(from, &mut to);
assert_eq!(to.remaining_mut(), 2);

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

Implementations

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

pub fn new(buf: B) -> Self

Construct a new write adapter.

pub fn as_ref(&self) -> &B

Access the underlying buffer.

Examples

use rotary::Buf as _;
use rotary::io;

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

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

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 _;
use rotary::io;

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

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

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 _;
use rotary::io;

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

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

let buffer = buffer.into_inner();

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

Trait Implementations

impl<B, T> Buf<T> for Write<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, T> BufMut<T> for Write<B> where
    B: BufMut<T>, 

fn channel_mut(&mut self, channel: usize) -> ChannelMut<'_, T>

Return a mutable handler to the buffer associated with the channel.

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

fn frames(&self) -> usize

The number of frames in a buffer.

impl<B> WriteBuf for Write<B>

fn remaining_mut(&self) -> usize

Remaining number of frames available.

fn advance_mut(&mut self, n: usize)

Advance the number of frames that have been written.

pub fn has_remaining_mut(&self) -> bool

Test if this buffer has remaining mutable frames that can be written.