Struct songbird::input::restartable::Restartable

pub struct Restartable { /* fields omitted */ }

A wrapper around a method to create a new Input which seeks backward by recreating the source.

The main purpose of this wrapper is to enable seeking on incompatible sources (i.e., ffmpeg output) and to ease resource consumption for commonly reused/shared tracks. Compressed and Memory offer the same functionality with different tradeoffs.

This is intended for use with single-use audio tracks which may require looping or seeking, but where additional memory cannot be spared. Forward seeks will drain the track until reaching the desired timestamp.

Implementations

impl Restartable

pub async fn new(
    recreator: impl Restart + Send + 'static,
    lazy: bool
) -> Result<Self>

Create a new source, which can be restarted using a recreator function.

Lazy sources will not run their input recreator until the first byte is needed, or are sent Track::make_playable/TrackHandle::make_playable.

pub async fn ffmpeg<P: AsRef<OsStr> + Send + Clone + Sync + 'static>(
    path: P,
    lazy: bool
) -> Result<Self>

Create a new restartable ffmpeg source for a local file.

pub async fn ytdl<P: AsRef<str> + Send + Clone + Sync + 'static>(
    uri: P,
    lazy: bool
) -> Result<Self>

Create a new restartable ytdl source.

The cost of restarting and seeking will probably be very high: expect a pause if you seek backwards.

pub async fn ytdl_search(name: &str, lazy: bool) -> Result<Self>

Create a new restartable ytdl source, using the first result of a youtube search.

The cost of restarting and seeking will probably be very high: expect a pause if you seek backwards.

Trait Implementations

impl Debug for Restartable

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

Formats the value using the given formatter.

impl From<Restartable> for Input

fn from(mut src: Restartable) -> Self

Performs the conversion.

impl Read for Restartable

fn read(&mut self, buffer: &mut [u8]) -> IoResult<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

pub fn read_vectored(
    &mut self,
    bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

pub fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

pub unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

pub fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

pub fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

pub fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl Seek for Restartable

fn seek(&mut self, pos: SeekFrom) -> IoResult<u64>

Seek to an offset, in bytes, in a stream.

pub fn stream_len(&mut self) -> Result<u64, Error>

🔬 This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes).

pub fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.