Struct nod::Disc

pub struct Disc { /* private fields */ }

An open disc image and read stream.

This is the primary entry point for reading disc images.

Implementations

impl Disc

pub fn new<P: AsRef<Path>>(path: P) -> Result<Disc>

Opens a disc image from a file path.

pub fn new_with_options<P: AsRef<Path>>( path: P, options: &OpenOptions ) -> Result<Disc>

Opens a disc image from a file path with custom options.

pub fn header(&self) -> &DiscHeader

The disc’s primary header.

pub fn meta(&self) -> DiscMeta

Returns extra metadata included in the disc file format, if any.

pub fn disc_size(&self) -> u64

The disc’s size in bytes, or an estimate if not stored by the format.

pub fn partitions(&self) -> &[PartitionInfo]

A list of Wii partitions on the disc.

GameCube: This will return an empty slice.

pub fn open_partition(&self, index: usize) -> Result<Box<dyn PartitionBase>>

Opens a decrypted partition read stream for the specified partition index.

GameCube: index must always be 0.

pub fn open_partition_kind( &self, kind: PartitionKind ) -> Result<Box<dyn PartitionBase>>

Opens a decrypted partition read stream for the first partition matching the specified kind.

GameCube: kind must always be PartitionKind::Data.

Trait Implementations

impl Read for Disc

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

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

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

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

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.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Read the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

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

impl Seek for Disc

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

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

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

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).

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

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

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

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

Seeks relative to the current position.