# [−][src]Struct image::tga::TGADecoder

    pub struct TGADecoder<R> { /* fields omitted */ }

The representation of a TGA decoder

## Methods

### `impl<R: Read + Seek> TGADecoder<R>`[src]

#### `pub fn new(r: R) -> ImageResult<TGADecoder<R>>`[src]

Create a new decoder that decodes from the stream `r`

## Trait Implementations

### `impl<R: Read + Seek> ImageDecoder for TGADecoder<R>`[src]

#### `type Reader = TGAReader<R>`

The type of reader produced by `into_reader`.

#### `fn dimensions(&self) -> (u64, u64)`[src]

Returns a tuple containing the width and height of the image

#### `fn colortype(&self) -> ColorType`[src]

Returns the color type of the image e.g. RGB(8) (8bit RGB)

#### `fn scanline_bytes(&self) -> u64`[src]

Returns the minimum number of bytes that can be efficiently read from this decoder. This may be as few as 1 or as many as `total_bytes()`. Read more

#### `fn into_reader(self) -> ImageResult<Self::Reader>`[src]

Returns a reader that can be used to obtain the bytes of the image. For the best performance, always try to read at least `scanline_bytes` from the reader at a time. Reading fewer bytes will cause the reader to perform internal buffering. Read more

#### `fn read_image(self) -> ImageResult<Vec<u8>>`[src]

Returns all the bytes in the image.

#### `fn row_bytes(&self) -> u64`[src]

Returns the number of bytes in a single row of the image. All decoders will pad image rows to a byte boundary. Read more

#### `fn total_bytes(&self) -> u64`[src]

Returns the total number of bytes in the image.

#### `fn read_image_with_progress<F: Fn(Progress)>(
self,
progress_callback: F
) -> ImageResult<Vec<u8>>`[src]

Same as `read_image` but periodically calls the provided callback to give updates on loading progress. Read more

## Auto Trait Implementations

### `impl<R> Send for TGADecoder<R> where
R: Send,`

### `impl<R> Unpin for TGADecoder<R> where
R: Unpin,`

### `impl<R> Sync for TGADecoder<R> where
R: Sync,`

### `impl<R> UnwindSafe for TGADecoder<R> where
R: UnwindSafe,`

### `impl<R> RefUnwindSafe for TGADecoder<R> where
R: RefUnwindSafe,`

## Blanket Implementations

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

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

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

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

### `impl<T> SetParameter for T`[src]

#### `fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,` [src]

Sets `value` as a parameter of `self`.

# 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`)