Struct ncmdump::Ncmdump

source ·
pub struct Ncmdump<S>where
    S: Read,{ /* private fields */ }
Expand description

The ncm file dump wrapper.

Implementations§

source§

impl<S> Ncmdump<S>where S: Read + Seek,

source

pub fn from_reader(reader: S) -> Result<Self, Errors>

Create a Ncmdump from a seekable reader. Usually, the reader is a File or Cursor.

Example

From a file.

let file = File::open("tests/test.ncm").expect("Can't open file");
let _ = Ncmdump::from_reader(file).unwrap();

Or from a Cursor.

let cursor = Cursor::new(data);
let _ = Ncmdump::from_reader(cursor).unwrap();
Examples found in repository?
examples/ncmdump.rs (line 14)
12
13
14
15
16
17
18
19
20
21
22
23
fn main() -> Result<()> {
    let file = File::open("tests/test.ncm")?;
    let mut ncm = Ncmdump::from_reader(file)?;
    let data = ncm.get_data()?;

    let mut target = File::options()
        .create(true)
        .write(true)
        .open("tests/test.flac")?;
    target.write_all(&data)?;
    Ok(())
}
More examples
Hide additional examples
examples/ncmdump_by_read.rs (line 15)
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
fn main() -> Result<()> {
    let file = File::open("tests/test.ncm")?;
    let mut ncm = Ncmdump::from_reader(file)?;
    let mut buf = [0; 1024];
    let mut target = File::options()
        .create(true)
        .write(true)
        .open("tests/test.flac")?;

    while let Ok(size) = ncm.read(&mut buf) {
        if size == 0 {
            break;
        }
        target.write_all(&buf[..size])?;
    }
    Ok(())
}
source

pub fn get_info(&mut self) -> Result<NcmInfo, Errors>

Decode the information buffer and just return the information.

Example
use std::fs::File;
use std::path::Path;

use anyhow::Result;
use ncmdump::Ncmdump;

fn main() -> Result<()> {
    let file = File::open("tests/test.ncm")?;
    let mut ncm = Ncmdump::from_reader(file)?;
    let info = ncm.get_info();
    println!("{:?}", info);
    Ok(())
}
source

pub fn get_image(&mut self) -> Result<Vec<u8>, Errors>

Get the image bytes from ncmdump, if it’s exists.

Example:
use std::fs::File;
use std::path::Path;

use anyhow::Result;
use ncmdump::Ncmdump;

fn main() -> Result<()> {
    use std::io::Write;
let file = File::open("tests/test.ncm")?;
    let mut ncm = Ncmdump::from_reader(file)?;
    let image = ncm.get_image()?;

    let mut target = File::options()
        .create(true)
        .write(true)
        .open("tests/test.jpeg")?;
    target.write_all(&image)?;
    Ok(())
}
source

pub fn get_data(&mut self) -> Result<Vec<u8>, Errors>

Get the music data from ncmdump.

Example:
use std::fs::File;
use std::io::Write;
use std::path::Path;

use anyhow::Result;
use ncmdump::Ncmdump;

fn main() -> Result<()> {
    let file = File::open("tests/test.ncm")?;
    let mut ncm = Ncmdump::from_reader(file)?;
    let music = ncm.get_data()?;

    let mut target = File::options()
        .create(true)
        .write(true)
        .open("tests/test.flac")?;
    target.write_all(&music)?;
    Ok(())
}
Examples found in repository?
examples/ncmdump.rs (line 15)
12
13
14
15
16
17
18
19
20
21
22
23
fn main() -> Result<()> {
    let file = File::open("tests/test.ncm")?;
    let mut ncm = Ncmdump::from_reader(file)?;
    let data = ncm.get_data()?;

    let mut target = File::options()
        .create(true)
        .write(true)
        .open("tests/test.flac")?;
    target.write_all(&data)?;
    Ok(())
}

Trait Implementations§

source§

impl<R> Read for Ncmdump<R>where R: Read + Seek,

source§

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. Read more
1.36.0 · source§

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

Like read, except that it reads into a slice of buffers. Read more
source§

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. Read more
1.0.0 · source§

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. Read more
1.0.0 · source§

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

Read all bytes until EOF in this source, appending them to buf. Read more
1.6.0 · source§

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

Read the exact number of bytes required to fill buf. Read more
source§

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. Read more
source§

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. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more
1.0.0 · source§

fn bytes(self) -> Bytes<Self>where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · source§

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

Creates an adapter which will chain this stream with another. Read more
1.0.0 · source§

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

Creates an adapter which will read at most limit bytes from it. Read more
source§

impl<R> Seek for Ncmdump<R>where R: Read + Seek,

source§

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

Seek to an offset, in bytes, in a stream. Read more
1.55.0 · source§

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

Rewind to the beginning of a stream. Read more
source§

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). Read more
1.51.0 · source§

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

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

Auto Trait Implementations§

§

impl<S> RefUnwindSafe for Ncmdump<S>where S: RefUnwindSafe,

§

impl<S> Send for Ncmdump<S>where S: Send,

§

impl<S> Sync for Ncmdump<S>where S: Sync,

§

impl<S> Unpin for Ncmdump<S>where S: Unpin,

§

impl<S> UnwindSafe for Ncmdump<S>where S: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.