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 _, ReadBuf as _, WriteBuf as _};
use rotary::io;

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

let to = rotary::interleaved![[0.0f32; 4]; 2];
let mut to = io::Write::new(to);

assert_eq!(to.remaining_mut(), 4);
io::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>

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

Construct a new writing adapter.

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

Examples

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

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

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

assert!(buffer.has_remaining_mut());
assert_eq!(buffer.remaining_mut(), 4);

pub fn empty(buf: B) -> Self

Construct a new writing adapter.

The constructed reader will be initialized so that there are no frames available to be written.

Examples

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

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

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

assert!(!buffer.has_remaining_mut());
assert_eq!(buffer.remaining_mut(), 0);

pub fn as_ref(&self) -> &B

Access the underlying buffer.

Examples

use rotary::{io, wrap};

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

io::copy_remaining(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::{io, wrap};
use rotary::Buf as _;

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

io::copy_remaining(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);

pub fn set_written(&mut self, written: usize) where
    B: ExactSizeBuf, 

Set the number of frames written.

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 read into through a call to Write::as_mut.

Examples

use rotary::{Buf, ChannelsMut, WriteBuf};
use rotary::io;

fn write_to_buf(mut write: impl Buf + ChannelsMut<i16> + WriteBuf) {
    let mut from = rotary::interleaved![[0; 4]; 2];
    io::copy_remaining(io::Read::new(&mut from), write);
}

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

assert!(!buffer.has_remaining_mut());

buffer.set_written(0);

assert!(buffer.has_remaining_mut());

Trait Implementations

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

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

Return a handler to the buffer associated with the channel.

impl<B, T> ChannelsMut<T> for Write<B> where
    B: ChannelsMut<T>, 

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

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

fn copy_channels(&mut self, from: usize, to: usize) where
    T: Copy, 

Copy one channel into another.

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.