# [−] [src] Struct serialization::Reader

    pub struct Reader<T> { /* fields omitted */ }

Bitcoin structures reader.

## Methods

###

`impl<'a> Reader<&'a [u8]>`

[src]

####

`pub fn new(buffer: &'a [u8]) -> Self`

[src]

Convenient way of creating for slice of bytes

###

`impl<R> Reader<R> where R: Read,`

[src]

####

`pub fn from_read(read: R) -> Self`

[src]

####

`pub fn read<T>(&mut self) -> Result<T, Error> where T: Deserializable,`

[src]

####

`pub fn read_with_proxy<T, F>(&mut self, proxy: F) -> Result<T, Error> where T: Deserializable, F: FnMut(&[u8]),`

[src]

####

`pub fn read_slice(&mut self, bytes: &mut [u8]) -> Result<(), Error>`

[src]

####

`pub fn read_list<T>(&mut self) -> Result<Vec<T>, Error> where T: Deserializable,`

[src]

####

`pub fn read_list_max<T>(&mut self, max: usize) -> Result<Vec<T>, Error> where T: Deserializable,`

[src]

####

`pub fn is_finished(&mut self) -> bool`

[src]

## Trait Implementations

###

`impl<T: Debug> Debug for Reader<T>`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`impl<T> Read for Reader<T> where T: Read,`

[src]

####

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

[src]

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

####

`unsafe fn initializer(&self) -> Initializer`

[src]

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

Determines if this `Read`er can work with buffers of uninitialized memory. Read more

####

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

1.0.0
[src]

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

####

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

1.0.0
[src]

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

####

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

1.6.0
[src]

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

####
ⓘImportant traits for &'a mut R

### Important traits for &'a mut R

`impl<'a, R> Read for &'a mut R where
R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`

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

1.0.0
[src]

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

####
ⓘImportant traits for Bytes<R>

### Important traits for Bytes<R>

`impl<R> Iterator for Bytes<R> where
R: Read, type Item = Result<u8, Error>;`

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

1.0.0
[src]

Transforms this `Read` instance to an [`Iterator`] over its bytes. Read more

####
ⓘImportant traits for Chain<T, U>

### Important traits for Chain<T, U>

`impl<T, U> Read for Chain<T, U> where
T: Read,
U: Read,`

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

1.0.0
[src]

Creates an adaptor which will chain this stream with another. Read more

####
ⓘImportant traits for Take<T>

### Important traits for Take<T>

`impl<T> Read for Take<T> where
T: Read,`

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

1.0.0
[src]

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

## Auto Trait Implementations

###

`impl<T> Send for Reader<T> where T: Send,`

###

`impl<T> Sync for Reader<T> where T: Sync,`

## Blanket Implementations

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

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

The type returned in the event of a conversion error.

####

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

[src]

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

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'a mut R

### Important traits for &'a mut R

`impl<'a, R> Read for &'a mut R where
R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

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

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

The type returned in the event of a conversion error.

####

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

[src]

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

Performs the conversion.

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'a mut R

### Important traits for &'a mut R

`impl<'a, R> Read for &'a mut R where
R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`

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

[src]

Mutably borrows from an owned value. Read more

###

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

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

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

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

###

`impl<R> ReadBytesExt for R where R: Read + ?Sized,`

[src]

####

`fn read_u8(&mut self) -> Result<u8, Error>`

[src]

Reads an unsigned 8 bit integer from the underlying reader. Read more

####

`fn read_i8(&mut self) -> Result<i8, Error>`

[src]

Reads a signed 8 bit integer from the underlying reader. Read more

####

`fn read_u16<T>(&mut self) -> Result<u16, Error> where T: ByteOrder,`

[src]

Reads an unsigned 16 bit integer from the underlying reader. Read more

####

`fn read_i16<T>(&mut self) -> Result<i16, Error> where T: ByteOrder,`

[src]

Reads a signed 16 bit integer from the underlying reader. Read more

####

`fn read_u24<T>(&mut self) -> Result<u32, Error> where T: ByteOrder,`

[src]

Reads an unsigned 24 bit integer from the underlying reader. Read more

####

`fn read_i24<T>(&mut self) -> Result<i32, Error> where T: ByteOrder,`

[src]

Reads a signed 24 bit integer from the underlying reader. Read more

####

`fn read_u32<T>(&mut self) -> Result<u32, Error> where T: ByteOrder,`

[src]

Reads an unsigned 32 bit integer from the underlying reader. Read more

####

`fn read_i32<T>(&mut self) -> Result<i32, Error> where T: ByteOrder,`

[src]

Reads a signed 32 bit integer from the underlying reader. Read more

####

`fn read_u64<T>(&mut self) -> Result<u64, Error> where T: ByteOrder,`

[src]

Reads an unsigned 64 bit integer from the underlying reader. Read more

####

`fn read_i64<T>(&mut self) -> Result<i64, Error> where T: ByteOrder,`

[src]

Reads a signed 64 bit integer from the underlying reader. Read more

####

`fn read_uint<T>(&mut self, nbytes: usize) -> Result<u64, Error> where T: ByteOrder,`

[src]

Reads an unsigned n-bytes integer from the underlying reader. Read more

####

`fn read_int<T>(&mut self, nbytes: usize) -> Result<i64, Error> where T: ByteOrder,`

[src]

Reads a signed n-bytes integer from the underlying reader. Read more

####

`fn read_f32<T>(&mut self) -> Result<f32, Error> where T: ByteOrder,`

[src]

Reads a IEEE754 single-precision (4 bytes) floating point number from the underlying reader. Read more

####

`fn read_f64<T>(&mut self) -> Result<f64, Error> where T: ByteOrder,`

[src]

Reads a IEEE754 double-precision (8 bytes) floating point number from the underlying reader. Read more

####

`fn read_u16_into<T>(&mut self, dst: &mut [u16]) -> Result<(), Error> where T: ByteOrder,`

[src]

Reads a sequence of unsigned 16 bit integers from the underlying reader. Read more

####

`fn read_u32_into<T>(&mut self, dst: &mut [u32]) -> Result<(), Error> where T: ByteOrder,`

[src]

Reads a sequence of unsigned 32 bit integers from the underlying reader. Read more

####

`fn read_u64_into<T>(&mut self, dst: &mut [u64]) -> Result<(), Error> where T: ByteOrder,`

[src]

Reads a sequence of unsigned 64 bit integers from the underlying reader. Read more

####

`fn read_i16_into<T>(&mut self, dst: &mut [i16]) -> Result<(), Error> where T: ByteOrder,`

[src]

Reads a sequence of signed 16 bit integers from the underlying reader. Read more

####

`fn read_i32_into<T>(&mut self, dst: &mut [i32]) -> Result<(), Error> where T: ByteOrder,`

[src]

Reads a sequence of signed 32 bit integers from the underlying reader. Read more

####

`fn read_i64_into<T>(&mut self, dst: &mut [i64]) -> Result<(), Error> where T: ByteOrder,`

[src]

Reads a sequence of signed 64 bit integers from the underlying reader. Read more

####

`unsafe fn read_f32_into_unchecked<T>( &mut self, dst: &mut [f32] ) -> Result<(), Error> where T: ByteOrder,`

[src]

Reads a sequence of IEEE754 single-precision (4 bytes) floating point numbers from the underlying reader. Read more

####

`unsafe fn read_f64_into_unchecked<T>( &mut self, dst: &mut [f64] ) -> Result<(), Error> where T: ByteOrder,`

[src]

Reads a sequence of IEEE754 double-precision (8 bytes) floating point numbers from the underlying reader. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)