quickraw

https://docs.rs/quickraw/0.1.6/quickraw/
Admin
quickraw is a pure Rust library to decode and render images from camera raw files with support for...
Tokens:10,881
Snippets:114
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Get EXIF Data

Source: https://docs.rs/quickraw

Shows how to extract EXIF information from a raw file.

```APIDOC
## Get EXIF Data

### Description
Retrieves EXIF information from a camera raw file.

### Method
Uses the `Export::export_exif_info` function.

### Parameters
- `input` (Input enum) - Specifies the input source, e.g., `Input::ByFile("sample.ARW")`.

### Request Example
```rust
use quickraw::Export;
use quickraw::Input;

let info = Export::export_exif_info(Input::ByFile("sample.ARW")).unwrap();

// info is a `quickexif::ParsedInfo` type.
let width = info.usize("width").unwrap();
```

### Response
- `info` (`quickexif::ParsedInfo`) - An object containing parsed EXIF information, including width, height, etc.
```

--------------------------------

### Get EXIF Data from Raw File

Source: https://docs.rs/quickraw/0.1.6/quickraw/index.html

Retrieves EXIF information from a raw file, including image dimensions. The returned info is a `quickexif::ParsedInfo` type.

```rust
use quickraw::Export;
let info = Export::export_exif_info(Input::ByFile("sample.ARW")).unwrap();

// info is a `quickexif::ParsedInfo` type, for more info please check https://docs.rs/quickexif
let width = info.usize("width").unwrap();
```

--------------------------------

### Pointable Deref Implementation

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Dereferences the given pointer to get a reference to the object. This is an unsafe operation.

```rust
unsafe fn deref<'a>(ptr: usize) -> &'a T
```

--------------------------------

### Pointable DerefMut Implementation

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Mutably dereferences the given pointer to get a mutable reference to the object. This is an unsafe operation.

```rust
unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
```

--------------------------------

### Output Struct and Constructor

Source: https://docs.rs/quickraw/0.1.6/quickraw/struct.Output.html

Details the Output struct and its constructor function `new`.

```APIDOC
## Struct Output

### Description
Contains options for image rendering.

### Constructor
#### `pub fn new(
    demosaicing_method: DemosaicingMethod,
    color_space: [f32; 9],
    gamma: [f32; 2],
    output_type: OutputType,
    auto_crop: bool,
    auto_rotate: bool,
) -> Output`

Creates a new `Output` instance with the specified rendering options.
```

--------------------------------

### Print EXIF Info

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Prints all parsed EXIF data from the input to a string.

```rust
pub fn print_exif_info(input: Input<'_>) -> Result<String, RawFileReadingError>
```

--------------------------------

### Pointable Init Implementation

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Initializes an object with the given initializer. This is an unsafe operation.

```rust
unsafe fn init(init: <T as Pointable>::Init) -> usize
```

--------------------------------

### Create New Export Instance

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Creates a new instance of the Export struct by reading input and output configurations.

```rust
pub fn new( input: Input<'_>, output: Output, ) -> Result<Self, RawFileReadingError>
```

--------------------------------

### Clone Trait Implementation for Output

Source: https://docs.rs/quickraw/0.1.6/quickraw/struct.Output.html

Documentation for the `Clone` trait implementation for the `Output` struct.

```APIDOC
## impl Clone for Output

### `fn clone(&self) -> Output`
Returns a duplicate of the value.

### `fn clone_from(&mut self, source: &Self)`
Performs copy-assignment from `source`.
```

--------------------------------

### Export Thumbnail

Source: https://docs.rs/quickraw

Demonstrates how to export a thumbnail from a raw file. This functionality requires the 'image' feature flag.

```APIDOC
## Export Thumbnail

### Description
Exports a thumbnail from a raw camera file and optionally saves it to a JPG file.

### Method
Uses the `Export::export_thumbnail_data` and `Export::export_thumbnail_to_file` functions.

### Parameters
- `raw_data` (bytes) - The raw camera file data.
- `output_path` (string) - The file path to save the thumbnail JPG.

### Request Example
```rust
use quickraw::Export;

let raw_data = std::fs::read("sample.ARW").unwrap();
let (thumbnail_data, orientation) = Export::export_thumbnail_data(&raw_data).unwrap();

// This function is available on feature `image` only.
Export::export_thumbnail_to_file("sample.ARW", "sample.thumbnail.jpg").unwrap();
```

### Response
- `thumbnail_data` (bytes) - The raw thumbnail data.
- `orientation` (integer) - The orientation of the thumbnail.
```

--------------------------------

### XYZ2SRGB Data Item

Source: https://docs.rs/quickraw/0.1.6/quickraw/data/static.XYZ2SRGB.html

Documentation for the static XYZ2SRGB item within the quickraw::data module.

```APIDOC
## Static XYZ2SRGB Copy item path

### Description
Represents a static array of f32 values for XYZ to sRGB color space conversion.

### Summary
```rust
pub static XYZ2SRGB: [f32; 9]
```

### Details
This static item is defined within the `quickraw::data` module and holds a 9-element array of f32, likely representing a color transformation matrix.
```

--------------------------------

### Print EXIF Info

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Prints all the parsed EXIF data from an input to a string.

```APIDOC
## POST /export/exif/print

### Description
Prints all the parsed EXIF data from an input.

### Method
POST

### Endpoint
`/export/exif/print`

### Parameters
#### Request Body
- **input** (Input<'_>) - Required - The input source for reading EXIF data.

### Request Example
```json
{
  "input": "..."
}
```

### Response
#### Success Response (200)
- **exif_string** (string) - A string containing all parsed EXIF data.

#### Response Example
```json
{
  "exif_string": "Make: Canon\nModel: Canon EOS 5D Mark IV\nDateTime Original: 2023-10-27T10:00:00\n..."
}
```
```

--------------------------------

### CloneToUninit Trait Implementation (Nightly)

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.DemosaicingMethod.html

A nightly-only experimental API for performing copy-assignment from self to an uninitialized destination. Use with caution.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

--------------------------------

### Export EXIF Info

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Exports the parsed EXIF data from the input.

```rust
pub fn export_exif_info( input: Input<'_>, ) -> Result<ParsedInfo, RawFileReadingError>
```

--------------------------------

### Define Output struct

Source: https://docs.rs/quickraw/0.1.6/quickraw/struct.Output.html

The primary structure for configuring image rendering parameters.

```rust
pub struct Output { /* private fields */ }
```

--------------------------------

### Export 16-bit Image from Raw File

Source: https://docs.rs/quickraw/0.1.6/quickraw/index.html

Configures and exports a 16-bit image from a raw file with specified color space, gamma, and demosaicing method. Auto cropping and rotation can also be configured.

```rust
use quickraw::{data, DemosaicingMethod, Input, Output, Export, OutputType};

let demosaicing_method = DemosaicingMethod::Linear;
let color_space = data::XYZ2SRGB;
let gamma = data::GAMMA_SRGB;
let output_type = OutputType::Raw16;
let auto_crop = false;
let auto_rotate = false;

let export_job = Export::new(
    Input::ByFile("sample.ARW"),
    Output::new(
        demosaicing_method,
        color_space,
        gamma,
        output_type,
        auto_crop,
        auto_rotate,
    ),
).unwrap();

let (image, width, height) = export_job.export_16bit_image();

// or you can also export an image with quality(only works when the output type is JPEG).
// notice that this function is available on feature `image` only.
export_job.export_image(92).unwrap();
```

--------------------------------

### Export rendered image from raw file

Source: https://docs.rs/quickraw

Configures rendering parameters and exports the image. Exporting with quality settings requires the 'image' feature flag.

```rust
use quickraw::{data, DemosaicingMethod, Input, Output, Export, OutputType};
 
let demosaicing_method = DemosaicingMethod::Linear;
let color_space = data::XYZ2SRGB;
let gamma = data::GAMMA_SRGB;
let output_type = OutputType::Raw16;
let auto_crop = false;
let auto_rotate = false;
 
let export_job = Export::new(
    Input::ByFile("sample.ARW"),
    Output::new(
        demosaicing_method,
        color_space,
        gamma,
        output_type,
        auto_crop,
        auto_rotate,
    ),
).unwrap();
 
let (image, width, height) = export_job.export_16bit_image();
 
// or you can also export an image with quality(only works when the output type is JPEG).
// notice that this function is available on feature `image` only.
export_job.export_image(92).unwrap();
```

--------------------------------

### Retrieve EXIF data from raw file

Source: https://docs.rs/quickraw

Parses EXIF information from a raw file input. The returned object is of type quickexif::ParsedInfo.

```rust
use quickraw::Export;
let info = Export::export_exif_info(Input::ByFile("sample.ARW")).unwrap();
 
// info is a `quickexif::ParsedInfo` type, for more info please check https://docs.rs/quickexif
let width = info.usize("width").unwrap();
```

--------------------------------

### Export Image with Quality

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Exports the rendered image to an Image file with a specified quality setting. Requires the 'image' feature flag.

```rust
pub fn export_image(&self, quality: u8) -> Result<(), Error>
```

--------------------------------

### Auto Trait Implementations for Output

Source: https://docs.rs/quickraw/0.1.6/quickraw/struct.Output.html

Lists the auto trait implementations for the `Output` struct.

```APIDOC
## Auto Trait Implementations

### `impl Freeze for Output`

### `impl RefUnwindSafe for Output`

### `impl Send for Output`

### `impl Sync for Output`

### `impl Unpin for Output`

### `impl UnwindSafe for Output`
```

--------------------------------

### CAM_XYZ_MAP Constant

Source: https://docs.rs/quickraw/0.1.6/quickraw/data/static.CAM_XYZ_MAP.html

Documentation for the static CAM_XYZ_MAP constant used in the quickraw::data module.

```APIDOC
## Static Constant: CAM_XYZ_MAP

### Description
A static map providing color space transformation data, mapping string keys to 9-element float arrays.

### Definition
`pub static CAM_XYZ_MAP: Map<&'static str, [f32; 9]>`
```

--------------------------------

### GAMMA_SRGB Constant

Source: https://docs.rs/quickraw/0.1.6/quickraw/data/static.GAMMA_SRGB.html

Documentation for the static GAMMA_SRGB constant used in the quickraw::data module.

```APIDOC
## GAMMA_SRGB

### Description
A static array representing the sRGB gamma value used within the quickraw data processing module.

### Type
`[f32; 2]`

### Usage
This constant is accessed via `quickraw::data::GAMMA_SRGB`.
```

--------------------------------

### Implement From<T> for T

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.RawFileReadingError.html

A trivial implementation of `From<T>` for `T`, which simply returns the input value unchanged. This is often used for identity conversions.

```rust
impl<T> From<T> for T
Source§
#### fn from(t: T) -> T
```

--------------------------------

### Export Thumbnail Data and File

Source: https://docs.rs/quickraw/0.1.6/quickraw/index.html

Exports thumbnail data from a raw file and optionally saves it to a JPG. This functionality requires the 'image' feature flag.

```rust
use quickraw::Export;

let raw_data = std::fs::read("sample.ARW").unwrap();
let (thumbnail_data, orientation) = Export::export_thumbnail_data(&raw_data).unwrap();

// notice that this function is available on feature `image` only.
quickraw::Export::export_thumbnail_to_file("sample.ARW", "sample.thumbnail.jpg").unwrap();
```

--------------------------------

### Export Thumbnail to File

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Exports the thumbnail image from raw data to a specified file path. Requires the 'image' feature flag.

```rust
pub fn export_thumbnail_to_file( input_path: &str, output_path: &str, ) -> Result<(), Error>
```

--------------------------------

### XYZ2ADOBE_RGB Constant

Source: https://docs.rs/quickraw/0.1.6/quickraw/data/static.XYZ2ADOBE_RGB.html

Provides details about the static XYZ2ADOBE_RGB constant within the quickraw::data module.

```APIDOC
## Static XYZ2ADOBE_RGB

### Description
Represents a static array of f32 values, likely a color transformation matrix.

### Source
`quickraw::data::XYZ2ADOBE_RGB`

### Type
`[f32; 9]`

### Summary
This constant is a 3x3 matrix used for converting XYZ color space values to Adobe RGB color space.
```

--------------------------------

### Input Enum Blanket Implementations

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.Input.html

Details the blanket implementations available for the Input enum.

```APIDOC
## Blanket Implementations

### impl<T> Any for T

#### fn type_id(&self) -> TypeId
Gets the `TypeId` of `self`.

### impl<T> Borrow<T> for T

#### fn borrow(&self) -> &T
Immutably borrows from an owned value.

### impl<T> BorrowMut<T> for T

#### fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value.

### impl<T> From<T> for T

#### fn from(t: T) -> T
Returns the argument unchanged.

### impl<T, U> Into<U> for T

#### fn into(self) -> U
Calls `U::from(self)`.

### impl<T> IntoEither for T

#### fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise.

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,
Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise.

### impl<T> Pointable for T

#### const ALIGN: usize
The alignment of pointer.

#### type Init = T
The type for initializers.

#### unsafe fn init(init: <T as Pointable>::Init) -> usize
Initializes a with the given initializer.

#### unsafe fn deref<'a>(ptr: usize) -> &'a T
Dereferences the given pointer.

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
Mutably dereferences the given pointer.

#### unsafe fn drop(ptr: usize)
Drops the object pointed to by the given pointer.

### impl<T, U> TryFrom<U> for T

#### 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>
Performs the conversion.

### impl<T, U> TryInto<U> for T

#### 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>
Performs the conversion.
```

--------------------------------

### Blanket Implementations for Output

Source: https://docs.rs/quickraw/0.1.6/quickraw/struct.Output.html

Details various blanket trait implementations available for the `Output` struct.

```APIDOC
## Blanket Implementations

### `impl<T> Any for T`

#### `fn type_id(&self) -> TypeId`
Gets the `TypeId` of `self`.

### `impl<T> Borrow<T> for T`

#### `fn borrow(&self) -> &T`
Immutably borrows from an owned value.

### `impl<T> BorrowMut<T> for T`

#### `fn borrow_mut(&mut self) -> &mut T`
Mutably borrows from an owned value.

### `impl<T> CloneToUninit for T`

#### `unsafe fn clone_to_uninit(&self, dest: *mut u8)`
Performs copy-assignment from `self` to `dest`.

### `impl<T> From<T> for T`

#### `fn from(t: T) -> T`
Returns the argument unchanged.

### `impl<T, U> Into<U> for T`

#### `fn into(self) -> U`
Calls `U::from(self)`.

### `impl<T> IntoEither for T`

#### `fn into_either(self, into_left: bool) -> Either<Self, Self>`
Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise.

#### `fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>`
Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise.

### `impl<T> Pointable for T`

#### `const ALIGN: usize`
The alignment of pointer.

#### `type Init = T`
The type for initializers.

#### `unsafe fn init(init: <T as Pointable>::Init) -> usize`
Initializes a with the given initializer.

#### `unsafe fn deref<'a>(ptr: usize) -> &'a T`
Dereferences the given pointer.

#### `unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T`
Mutably dereferences the given pointer.

#### `unsafe fn drop(ptr: usize)`
Drops the object pointed to by the given pointer.

### `impl<T> ToOwned for T`

#### `type Owned = T`
The resulting type after obtaining ownership.

#### `fn to_owned(&self) -> T`
Creates owned data from borrowed data, usually by cloning.

#### `fn clone_into(&self, target: &mut T)`
Uses borrowed data to replace owned data, usually by cloning.

### `impl<T, U> TryFrom<U> for T`

#### `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>`
Performs the conversion.

### `impl<T, U> TryInto<U> for T`

#### `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>`
Performs the conversion.
```

--------------------------------

### XYZ2RAW Static Constant

Source: https://docs.rs/quickraw/0.1.6/quickraw/data/static.XYZ2RAW.html

Details regarding the XYZ2RAW static array used in the quickraw::data module.

```APIDOC
## Static Constant: XYZ2RAW

### Description
A static array of 9 floating-point numbers (f32) used for XYZ to RAW data conversion.

### Definition
`pub static XYZ2RAW: [f32; 9]`

### Module
`quickraw::data`
```

--------------------------------

### Export EXIF Info

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Exports the parsed EXIF data from an input.

```APIDOC
## POST /export/exif/info

### Description
Exports the parsed EXIF data from an input.

### Method
POST

### Endpoint
`/export/exif/info`

### Parameters
#### Request Body
- **input** (Input<'_>) - Required - The input source for reading EXIF data.

### Request Example
```json
{
  "input": "..."
}
```

### Response
#### Success Response (200)
- **parsed_info** (ParsedInfo) - The structure containing parsed EXIF information.

#### Response Example
```json
{
  "parsed_info": {
    "make": "Canon",
    "model": "Canon EOS 5D Mark IV",
    "datetime_original": "2023-10-27T10:00:00"
  }
}
```
```

--------------------------------

### new_image_from_buffer

Source: https://docs.rs/quickraw/0.1.6/quickraw/fn.new_image_from_buffer.html

Creates a RawImage from a byte buffer.

```APIDOC
## new_image_from_buffer

### Description
Gets `RawImage` from a buffer.

### Method
`pub fn`

### Endpoint
N/A (Rust function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **buffer** (Vec<u8>) - Required - The byte vector containing image data.

### Request Example
```rust
let image_data: Vec<u8> = vec![...]; // Your image byte data
let raw_image = quickraw::new_image_from_buffer(image_data);
```

### Response
#### Success Response (Result<RawImage, RawFileReadingError>)
- **RawImage**: Represents the decoded image.
- **RawFileReadingError**: Represents an error during file reading.

#### Response Example
```rust
// On success:
// let raw_image: RawImage = ...;

// On error:
// let error: RawFileReadingError = ...;
```
```

--------------------------------

### Create RawImage from Buffer

Source: https://docs.rs/quickraw/0.1.6/quickraw/fn.new_image_from_buffer.html

Use this function to create a RawImage from a byte buffer. It returns a Result which can be Ok(RawImage) or Err(RawFileReadingError).

```rust
pub fn new_image_from_buffer(
    buffer: Vec<u8>,
) -> Result<RawImage, RawFileReadingError>
```

--------------------------------

### Export Thumbnail to File

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Exports the thumbnail image from a raw file to a specified output path. This functionality requires the 'image' feature flag to be enabled.

```APIDOC
## POST /export/thumbnail

### Description
Exports the thumbnail image from a raw file to a specified output path.

### Method
POST

### Endpoint
`/export/thumbnail`

### Parameters
#### Query Parameters
- **input_path** (string) - Required - The path to the input raw file.
- **output_path** (string) - Required - The path where the thumbnail image will be saved.

### Request Example
```json
{
  "input_path": "/path/to/your/raw/file.cr2",
  "output_path": "/path/to/save/thumbnail.jpg"
}
```

### Response
#### Success Response (200)
- **message** (string) - Indicates successful export.

#### Response Example
```json
{
  "message": "Thumbnail exported successfully to /path/to/save/thumbnail.jpg"
}
```
```

--------------------------------

### Input Enum Auto Trait Implementations

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.Input.html

Lists the auto trait implementations for the Input enum.

```APIDOC
## Auto Trait Implementations

### impl<'a> Freeze for Input<'a>

### impl<'a> RefUnwindSafe for Input<'a>

### impl<'a> Send for Input<'a>

### impl<'a> Sync for Input<'a>

### impl<'a> Unpin for Input<'a>

### impl<'a> UnwindSafe for Input<'a>
```

--------------------------------

### Implement Clone for OutputType

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.OutputType.html

Provides methods to create a duplicate of an OutputType value or perform copy-assignment from another value.

```rust
fn clone(&self) -> OutputType
```

```rust
fn clone_from(&mut self, source: &Self)
```

--------------------------------

### Implement ToString for T

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.RawFileReadingError.html

Provides a `to_string` method for any type `T` that implements `Display`. This allows converting values into their string representations.

```rust
impl<T> ToString for T
where T: Display + ?Sized,
Source§
#### fn to_string(&self) -> String
```

--------------------------------

### Access XYZ2ADOBE_RGB constant

Source: https://docs.rs/quickraw/0.1.6/quickraw/data/static.XYZ2ADOBE_RGB.html

Represents the transformation matrix from XYZ to Adobe RGB color space as a static array of 9 f32 values.

```rust
pub static XYZ2ADOBE_RGB: [f32; 9]
```

--------------------------------

### GAMMA_LINEAR Data Item

Source: https://docs.rs/quickraw/0.1.6/quickraw/data/static.GAMMA_LINEAR.html

Information about the GAMMA_LINEAR static item within the quickraw::data module.

```APIDOC
## GAMMA_LINEAR

### Description
Represents a static GAMMA_LINEAR copy item path.

### Type
`[f32; 2]`

### Source
`quickraw::data::GAMMA_LINEAR`
```

--------------------------------

### new_image_from_file

Source: https://docs.rs/quickraw/0.1.6/quickraw/fn.new_image_from_file.html

Function to load a RawImage from a file path.

```APIDOC
## new_image_from_file

### Description
Gets a `RawImage` from a file.

### Parameters
- **path** (&str) - Required - The file path to the raw image.

### Response
- **Result<RawImage, RawFileReadingError>** - Returns a `RawImage` on success, or a `RawFileReadingError` if the file cannot be read.
```

--------------------------------

### Implement Pointable for T

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.RawFileReadingError.html

Defines methods for pointer manipulation, including alignment, initialization, dereferencing, and dropping. This is an experimental nightly-only API.

```rust
impl<T> Pointable for T
Source§
#### const ALIGN: usize
```

```rust
#### type Init = T
```

```rust
#### unsafe fn init(init: <T as Pointable>::Init) -> usize
```

```rust
#### unsafe fn deref<'a>(ptr: usize) -> &'a T
```

```rust
#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
```

```rust
#### unsafe fn drop(ptr: usize)
```

--------------------------------

### TryFrom Trait Implementation for DemosaicingMethod

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.DemosaicingMethod.html

Allows attempting to convert a value into DemosaicingMethod, returning a Result. This is used for fallible conversions where the source type implements `Into<DemosaicingMethod>`.

```rust
type Error = Infallible
```

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

--------------------------------

### Input Enum Definition

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.Input.html

Defines the Input enum with variants for file path and byte buffer.

```APIDOC
## Enum Input

### Description
Chooses the input from a file or a buffer.

### Variants

#### ByFile(&'a str)

#### ByBuffer(Vec<u8>)
```

--------------------------------

### Export Image with Quality

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Exports the rendered image to an image file with a specified quality setting. This functionality requires the 'image' feature flag.

```APIDOC
## POST /export/image

### Description
Exports the rendered image to an image file with a specified quality.

### Method
POST

### Endpoint
`/export/image`

### Parameters
#### Request Body
- **quality** (u8) - Required - The quality setting for the exported image (0-100).

### Request Example
```json
{
  "quality": 85
}
```

### Response
#### Success Response (200)
- **image_data** (string) - Base64 encoded image data.
- **format** (string) - The format of the exported image (e.g., 'JPEG', 'PNG').

#### Response Example
```json
{
  "image_data": "/9j/4AAQSkZJRgABAQEASABIAAD...",
  "format": "JPEG"
}
```
```

--------------------------------

### Implement Into<U> for T

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.RawFileReadingError.html

Provides a generic `into` method for converting type `T` into type `U`, provided that `U` implements `From<T>`. This enables type conversions using the `into()` method.

```rust
impl<T, U> Into<U> for T
where U: From<T>,
Source§
#### fn into(self) -> U
```

--------------------------------

### Export 16-bit Image Data

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Exports 16-bit image RGB data along with its width and height.

```APIDOC
## GET /export/image/16bit

### Description
Exports 16-bit image RGB data with width and height.

### Method
GET

### Endpoint
`/export/image/16bit`

### Response
#### Success Response (200)
- **rgb_data** (array of u16) - The 16-bit RGB pixel data.
- **width** (usize) - The width of the image.
- **height** (usize) - The height of the image.

#### Response Example
```json
{
  "rgb_data": [65535, 0, 0, 0, 65535, 0, ...],
  "width": 1920,
  "height": 1080
}
```
```

--------------------------------

### TryInto::try_into

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.RawFileReadingError.html

Performs the conversion from type T to type U, returning a Result.

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

### Description
Performs the conversion from the source type T into the target type U. This is a fallible operation.

### Parameters
#### Path Parameters
- **self** (T) - Required - The instance of the type to be converted.

### Response
#### Success Response (200)
- **Result<U, Error>** (Result) - Returns Ok(U) if the conversion succeeds, or Err(Error) if it fails.
```

--------------------------------

### Into Trait Implementation for DemosaicingMethod

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.DemosaicingMethod.html

Enables converting a DemosaicingMethod into another type that implements `From<DemosaicingMethod>`. This leverages the `From` trait for conversions.

```rust
fn into(self) -> U
```

--------------------------------

### Implement Any for T

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.RawFileReadingError.html

Provides the `Any` trait implementation for any type `T` that is `'static` and sized. This allows for type-based downcasting.

```rust
impl<T> Any for T
where T: 'static + ?Sized,
Source§
#### fn type_id(&self) -> TypeId
```

--------------------------------

### Export 16-bit Image Data

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Exports 16-bit RGB image data as a vector, along with its width and height.

```rust
pub fn export_16bit_image(&self) -> (Vec<u16>, usize, usize)
```

--------------------------------

### Export 8-bit Image Data

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Exports 8-bit RGB image data as a vector, along with its width and height.

```rust
pub fn export_8bit_image(&self) -> (Vec<u8>, usize, usize)
```

--------------------------------

### Export thumbnail from raw file

Source: https://docs.rs/quickraw

Extracts thumbnail data or saves it directly to a file. Note that exporting to a file requires the 'image' feature flag.

```rust
use quickraw::Export;
 
let raw_data = std::fs::read("sample.ARW").unwrap();
let (thumbnail_data, orientation) = Export::export_thumbnail_data(&raw_data).unwrap();
 
// notice that this function is available on feature `image` only.
quickraw::Export::export_thumbnail_to_file("sample.ARW", "sample.thumbnail.jpg").unwrap();
```

--------------------------------

### Any Trait Implementation for DemosaicingMethod

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.DemosaicingMethod.html

Allows DemosaicingMethod to be treated as any type that is 'static. This is a standard Rust trait for dynamic typing.

```rust
fn type_id(&self) -> TypeId
```

--------------------------------

### Export 8-bit Image Data

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Exports 8-bit image RGB data along with its width and height.

```APIDOC
## GET /export/image/8bit

### Description
Exports 8-bit image RGB data with width and height.

### Method
GET

### Endpoint
`/export/image/8bit`

### Response
#### Success Response (200)
- **rgb_data** (array of u8) - The 8-bit RGB pixel data.
- **width** (usize) - The width of the image.
- **height** (usize) - The height of the image.

#### Response Example
```json
{
  "rgb_data": [255, 0, 0, 0, 255, 0, ...],
  "width": 1920,
  "height": 1080
}
```
```

--------------------------------

### Export Thumbnail Data

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Exports a byte slice reference of thumbnail data along with its orientation.

```rust
pub fn export_thumbnail_data( buffer: &[u8], ) -> Result<(&[u8], Orientation), Error>
```

--------------------------------

### TryInto Trait Implementation for DemosaicingMethod

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.DemosaicingMethod.html

Enables attempting to convert a DemosaicingMethod into another type that implements `TryFrom<DemosaicingMethod>`. This provides a fallible conversion mechanism.

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

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

--------------------------------

### Export Thumbnail Data

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Exports the thumbnail data as a u8 array reference along with its orientation.

```APIDOC
## POST /export/thumbnail/data

### Description
Exports the thumbnail data as a u8 array reference and its orientation.

### Method
POST

### Endpoint
`/export/thumbnail/data`

### Parameters
#### Request Body
- **buffer** (bytes) - Required - The buffer containing the raw image data.

### Request Example
```json
{
  "buffer": "...raw image bytes..."
}
```

### Response
#### Success Response (200)
- **thumbnail_data** (bytes) - The raw thumbnail data.
- **orientation** (string) - The orientation of the thumbnail (e.g., 'Horizontal', 'Rotate90').

#### Response Example
```json
{
  "thumbnail_data": "...thumbnail bytes...",
  "orientation": "Horizontal"
}
```
```

--------------------------------

### Clone Trait Implementation for DemosaicingMethod

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.DemosaicingMethod.html

Provides methods to duplicate DemosaicingMethod values. This is useful for creating copies of the demosaicing method setting.

```rust
fn clone(&self) -> DemosaicingMethod
```

```rust
fn clone_from(&mut self, source: &Self)
```

--------------------------------

### Export Image

Source: https://docs.rs/quickraw

Details on exporting a full image from a raw file with customizable rendering options. This functionality requires the 'image' feature flag for JPEG export.

```APIDOC
## Export Image

### Description
Exports a full image from a camera raw file with specified rendering parameters, or exports it as a JPEG with a given quality.

### Method
Uses `Export::new` to create an export job and then `export_16bit_image` or `export_image`.

### Parameters
- `input` (Input enum) - Specifies the input source, e.g., `Input::ByFile("sample.ARW")`.
- `output` (Output struct) - Contains rendering options:
  - `demosaicing_method` (DemosaicingMethod) - The method for demosaicing.
  - `color_space` (data::ColorSpace) - The target color space.
  - `gamma` (data::Gamma) - The gamma correction.
  - `output_type` (OutputType) - The desired output bit depth (e.g., `Raw16`).
  - `auto_crop` (boolean) - Whether to automatically crop the image.
  - `auto_rotate` (boolean) - Whether to automatically rotate the image.
- `quality` (integer, optional) - JPEG quality (0-100) when using `export_image`.

### Request Example
```rust
use quickraw::{data, DemosaicingMethod, Input, Output, Export, OutputType};

let demosaicing_method = DemosaicingMethod::Linear;
let color_space = data::XYZ2SRGB;
let gamma = data::GAMMA_SRGB;
let output_type = OutputType::Raw16;
let auto_crop = false;
let auto_rotate = false;

let export_job = Export::new(
    Input::ByFile("sample.ARW"),
    Output::new(
        demosaicing_method,
        color_space,
        gamma,
        output_type,
        auto_crop,
        auto_rotate,
    ),
).unwrap();

let (image, width, height) = export_job.export_16bit_image();

// Export as JPEG with quality 92 (requires 'image' feature)
// export_job.export_image(92).unwrap();
```

### Response
- `image` (bytes) - The exported image data.
- `width` (integer) - The width of the exported image.
- `height` (integer) - The height of the exported image.
```

--------------------------------

### TryInto Implementation

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Performs the conversion from type T to type U. This is a standard trait implementation.

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

--------------------------------

### IntoEitherWith Implementation

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Converts `self` into a `Left` or `Right` variant of `Either<Self, Self>` based on the result of a closure.

```rust
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,
```

--------------------------------

### TryFrom Implementation

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Performs the conversion from type U to type T. This is a standard trait implementation.

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

--------------------------------

### Implement Display for RawFileReadingError

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.RawFileReadingError.html

Provides a Display implementation for RawFileReadingError, enabling user-friendly string representations of errors. This is useful for logging or user feedback.

```rust
impl Display for RawFileReadingError
Source§
#### fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result
```

--------------------------------

### DemosaicingMethod Enum Definition

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.DemosaicingMethod.html

Defines the available methods for image demosaicing. Use this enum to specify which demosaicing algorithm to apply.

```rust
pub enum DemosaicingMethod {
    None,
    SuperPixel,
    Linear,
}
```

--------------------------------

### Pointable Trait Implementation for DemosaicingMethod

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.DemosaicingMethod.html

Defines constants and unsafe methods for pointer-based operations on DemosaicingMethod. This is for low-level memory management.

```rust
const ALIGN: usize
```

```rust
type Init = T
```

```rust
unsafe fn init(init: <T as Pointable>::Init) -> usize
```

```rust
unsafe fn deref<'a>(ptr: usize) -> &'a T
```

```rust
unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
```

```rust
unsafe fn drop(ptr: usize)
```

--------------------------------

### Export Struct Definition

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Defines the Export struct used for rendering and exporting image data. It has private fields.

```rust
pub struct Export { /* private fields */ }
```

--------------------------------

### From Trait Implementation for DemosaicingMethod

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.DemosaicingMethod.html

Allows creating a DemosaicingMethod from a value of the same type. This is a simple identity conversion.

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

--------------------------------

### Implement TryFrom<U> for T

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.RawFileReadingError.html

Enables attempting to convert type `U` into type `T`, returning a `Result`. The associated `Error` type is `Infallible` if the conversion is always possible.

```rust
impl<T, U> TryFrom<U> for T
where U: Into<T>,
Source§
#### type Error = Infallible
```

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

--------------------------------

### Define Input enum

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.Input.html

The Input enum provides two variants for handling data input: ByFile for file paths and ByBuffer for in-memory byte vectors.

```rust
pub enum Input<'a> {
    ByFile(&'a str),
    ByBuffer(Vec<u8>),
}
```

--------------------------------

### Implement From<RawFileReadingError> for Error

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.RawFileReadingError.html

Enables converting a `RawFileReadingError` into a generic `Error`. This facilitates propagating specific errors as general ones.

```rust
impl From<RawFileReadingError> for Error
Source§
#### fn from(source: RawFileReadingError) -> Self
```

--------------------------------

### Define BENCH_FLAG constant

Source: https://docs.rs/quickraw/0.1.6/quickraw/constant.BENCH_FLAG.html

This constant is used to enable benchmarking for key processes within the crate.

```rust
pub const BENCH_FLAG: &str = "QUICKRAW_BENCH";
```

--------------------------------

### IntoEither Implementation

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Converts `self` into a `Left` or `Right` variant of `Either<Self, Self>` based on the `into_left` boolean flag.

```rust
fn into_either(self, into_left: bool) -> Either<Self, Self>
```

--------------------------------

### Implement From<Error> for RawFileReadingError

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.RawFileReadingError.html

Allows converting a generic `Error` into a `RawFileReadingError`. This is useful for integrating with other error handling mechanisms.

```rust
impl From<Error> for RawFileReadingError
Source§
#### fn from(source: Error) -> Self
```

```rust
impl From<Error> for RawFileReadingError
Source§
#### fn from(source: Error) -> Self
```

--------------------------------

### Implement Borrow for T

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.RawFileReadingError.html

Implements the `Borrow` trait for any type `T`. This allows borrowing a reference to `T` from an owned value of `T`.

```rust
impl<T> Borrow<T> for T
where T: ?Sized,
Source§
#### fn borrow(&self) -> &T
```

--------------------------------

### Borrow Trait Implementation for DemosaicingMethod

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.DemosaicingMethod.html

Enables borrowing DemosaicingMethod values immutably. This is a fundamental trait for accessing data without taking ownership.

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

--------------------------------

### Implement Debug for RawFileReadingError

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.RawFileReadingError.html

Provides a Debug implementation for RawFileReadingError, allowing it to be formatted for debugging purposes. This is automatically derived for most enums.

```rust
impl Debug for RawFileReadingError
Source§
#### fn fmt(&self, f: &mut Formatter<'_>) -> Result
```

--------------------------------

### DemosaicingMethod Enum

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.DemosaicingMethod.html

The DemosaicingMethod enum specifies the algorithm used for demosaicing raw image data.

```APIDOC
## DemosaicingMethod

### Description
An enumeration representing all the demosaicing methods currently supported by the quickraw library.

### Variants
- **None** - No demosaicing applied.
- **SuperPixel** - SuperPixel demosaicing method.
- **Linear** - Linear demosaicing method.
```

--------------------------------

### BorrowMut Trait Implementation for DemosaicingMethod

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.DemosaicingMethod.html

Enables borrowing DemosaicingMethod values mutably. This allows for in-place modification of the demosaicing method.

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

--------------------------------

### Pointable Drop Implementation

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/struct.Export.html

Drops the object pointed to by the given pointer. This is an unsafe operation.

```rust
unsafe fn drop(ptr: usize)
```

--------------------------------

### Implement Error trait for RawFileReadingError

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.RawFileReadingError.html

Implements the standard Error trait for RawFileReadingError, providing methods like `source()` and `description()` for error introspection. The `description()` method is deprecated.

```rust
impl Error for RawFileReadingError
Source§
#### fn source(&self) -> Option<&(dyn Error + 'static)>
```

```rust
#### fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · Source
```

```rust
#### fn cause(&self) -> Option<&dyn Error>
👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source
```

```rust
#### fn provide<'a>(&'a self, request: &mut Request<'a>)
🔬This is a nightly-only experimental API. (`error_generic_member_access`)
Provides type-based access to context intended for error reports. Read more
Source
```

--------------------------------

### IntoEither Trait Implementation for DemosaicingMethod

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.DemosaicingMethod.html

Provides methods to convert a DemosaicingMethod into either the Left or Right variant of an `Either` enum. Useful for branching logic based on a boolean condition.

```rust
fn into_either(self, into_left: bool) -> Either<Self, Self>
```

```rust
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,
```

--------------------------------

### Implement BorrowMut for T

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.RawFileReadingError.html

Implements the `BorrowMut` trait for any type `T`. This allows obtaining a mutable reference to `T` from an owned value of `T`.

```rust
impl<T> BorrowMut<T> for T
where T: ?Sized,
Source§
#### fn borrow_mut(&mut self) -> &mut T
```

--------------------------------

### ToOwned Trait Implementation for DemosaicingMethod

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.DemosaicingMethod.html

Enables creating an owned version of DemosaicingMethod from a borrowed reference, typically by cloning. Also provides a method to clone into an existing mutable target.

```rust
type Owned = T
```

```rust
fn to_owned(&self) -> T
```

```rust
fn clone_into(&self, target: &mut T)
```

--------------------------------

### Implement IntoEither for T

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.RawFileReadingError.html

Allows converting a value into either the left or right variant of an `Either` enum. The direction of conversion is controlled by a boolean flag or a closure.

```rust
impl<T> IntoEither for T
Source§
#### fn into_either(self, into_left: bool) -> Either<Self, Self>
```

```rust
#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,
```

--------------------------------

### Define OutputType Enum

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.OutputType.html

This enum determines the format of the output, allowing for 8-bit or 16-bit raw data or image representations. Variants Image8 and Image16 include a String for additional data.

```rust
pub enum OutputType {
    Raw8,
    Raw16,
    Image8(String),
    Image16(String),
}
```

--------------------------------

### quickraw::Error Enum

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/enum.Error.html

The Error enum represents errors that occur during raw file reading and image exporting processes.

```APIDOC
## Error Enum

### Description
Represents errors that can occur during raw file reading and image exporting operations.

### Variants
- **RawFileReadingError(RawFileReadingError)** - Error encountered while reading a raw file.
- **InvalidFileForNewExport(String)** - The provided file is invalid for a new export operation.
- **ErrorWhenExportingFile(String)** - An error occurred during the file export process.
- **ImageBufferError(String, usize, usize, usize)** - An error related to the image buffer, including dimensions.
- **CannotReadThumbnail(usize, String)** - Failed to read a thumbnail at the specified index.
```

--------------------------------

### Define GAMMA_LINEAR constant

Source: https://docs.rs/quickraw/0.1.6/quickraw/data/static.GAMMA_LINEAR.html

Represents the static array constant used for linear gamma calculations.

```rust
pub static GAMMA_LINEAR: [f32; 2]
```

--------------------------------

### Enum OutputType

Source: https://docs.rs/quickraw/0.1.6/quickraw/enum.OutputType.html

The OutputType enum defines the output configuration for image processing operations, supporting both raw data and formatted image outputs at different bit depths.

```APIDOC
## Enum OutputType

### Description
Decides if the output should be 8bit or 16bit, and whether to return raw data or formatted image data.

### Variants
- **Raw8** - 8-bit raw output.
- **Raw16** - 16-bit raw output.
- **Image8(String)** - 8-bit image output with a string identifier.
- **Image16(String)** - 16-bit image output with a string identifier.
```

--------------------------------

### Define Error Enum

Source: https://docs.rs/quickraw/0.1.6/quickraw/export/enum.Error.html

The Error enum captures specific failure modes during raw file reading and image exporting.

```rust
pub enum Error {
    RawFileReadingError(RawFileReadingError),
    InvalidFileForNewExport(String),
    ErrorWhenExportingFile(String),
    ImageBufferError(String, usize, usize, usize),
    CannotReadThumbnail(usize, String),
}
```
Tokens:
Raw