Manifest Gen

https://docs.rs/manifest-gen/0.2.3/manifest_gen/
Admin
Manifest Gen is a Rust library for generating web app manifests and application icons with...
Tokens:4,690
Snippets:94
Trust Score:9.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Define START_URL Constant

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/constants/constant.START_URL.html

This constant defines the default starting URL for the application, typically the root path.

```rust
pub const START_URL: &str = "/";
```

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

### Set Manifest Start URL

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Manifest.html

Sets the default URL that is loaded when the user launches the web application. This is a builder pattern method returning Self.

```rust
pub fn start_url(self, start_url: String) -> Self
```

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

### Implementing Error::description (Deprecated)

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/enum.IconGenerationError.html

A deprecated method for getting a string description of the error. It is recommended to use the `Display` implementation or `to_string()` instead.

```rust
fn description(&self) -> &str
```

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

### Convert Orientation to String

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.Orientation.html

Implements the ToString trait for the Orientation enum, allowing conversion to a String. This is a convenient way to get a string representation.

```rust
fn to_string(&self) -> String>
```

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

### Generic TypeId Implementation

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Gets the TypeId of a generic type T. This is part of the Any trait implementation.

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

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

### Generic Pointable Dereference

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Dereferences a usize pointer to get an immutable reference to a generic type T.

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

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

### Generic Pointable Mutable Dereference

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Mutably dereferences a usize pointer to get a mutable reference to a generic type T.

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

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

### Get Type ID

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.Orientation.html

Retrieves the unique TypeId of an Orientation instance. This is part of the Any trait implementation and useful for runtime type identification.

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

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

### Icon Constructor

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Creates a new Icon instance. Requires a source string and a sizes string.

```rust
pub fn new(src: String, sizes: String) -> Self
```

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

### Default Manifest

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Manifest.html

Provides a default `Manifest` instance.

```APIDOC
## Default Manifest

### `default() -> Manifest`
Returns the default value for `Manifest`.
```

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

### Icon::new

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Constructs a new Icon with the specified source and sizes.

```APIDOC
## Icon::new

### Description
Constructs a new Icon with the specified source and sizes.

### Signature
`pub fn new(src: String, sizes: String) -> Self`

### Parameters
* `src` (String) - The source path or identifier for the icon.
* `sizes` (String) - A string representing the different sizes available for the icon.
```

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

### ManifestBuilder::build_manifest

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/struct.ManifestBuilder.html

Constructs a Manifest from a vector of Icons. This is the primary method for creating a manifest.

```APIDOC
## ManifestBuilder::build_manifest

### Description
Constructs a `Manifest` from a vector of `Icon`s.

### Signature
```rust
pub fn build_manifest(icons: Vec<Icon>) -> Manifest
```

### Parameters
* `icons` (Vec<Icon>) - A vector of `Icon` objects to include in the manifest.
```

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

### Manifest Configuration Methods

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Manifest.html

These methods allow you to configure the properties of the Manifest struct. Each method returns `Self`, enabling chained calls for fluent configuration.

```APIDOC
## Manifest Configuration

### `name(self, name: String) -> Self`
Sets the name of the web application.

### `short_name(self, short_name: String) -> Self`
Sets the short name of the web application, used when space is limited.

### `theme_color(self, theme_color: String) -> Self`
Sets the theme color for the web application.

### `background_color(self, background_color: String) -> Self`
Sets the background color for the web application.

### `display(self, display: DisplayMode) -> Self`
Sets the display mode of the web application (e.g., fullscreen, standalone).

### `orientation(self, orientation: Orientation) -> Self`
Sets the default orientation for the web application.

### `scope(self, scope: String) -> Self`
Sets the scope of the web application's navigation.

### `start_url(self, start_url: String) -> Self`
Sets the URL that the web application should load when launched.

### `icons(self, icons: Vec<Icon>) -> Self`
Sets the icons for the web application, used in various contexts.
```

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

### Implementing Error::provide (Nightly-only)

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/enum.IconGenerationError.html

An experimental, nightly-only API for providing type-based access to error context, intended for error reporting tools.

```rust
fn provide<'a>(&'a self, request: &mut Request<'a>)
```

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

### Orientation::all() Method

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.Orientation.html

Returns a vector containing all possible Orientation variants.

```APIDOC
## impl Orientation

### pub fn all() -> Vec<Self>
Returns a vector containing all possible Orientation variants.
```

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

### Implement Default for Manifest

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Manifest.html

Provides a default value for the Manifest struct, allowing it to be created without explicitly setting all fields.

```rust
fn default() -> Manifest
```

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

### DisplayMode::all()

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.DisplayMode.html

Returns a vector containing all possible DisplayMode variants.

```APIDOC
## impl DisplayMode

### pub fn all() -> Vec<Self>
Returns a vector containing all possible `DisplayMode` variants.
```

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

### Initialize Orientation Pointer

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.Orientation.html

Provides a way to initialize a pointer with an Orientation value. This is an unsafe operation and should be used with caution.

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

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

### DisplayMode::fmt() for Display

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.DisplayMode.html

Formats the DisplayMode value for display to the user. This implementation is automatically derived.

```rust
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult
```

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

### DisplayMode::all() Function

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.DisplayMode.html

Returns a vector containing all possible DisplayMode variants. Useful for iterating through all available display options.

```rust
pub fn all() -> Vec<Self>
```

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

### Implement build_manifest Function

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/struct.ManifestBuilder.html

Provides the implementation for the `build_manifest` function associated with the `ManifestBuilder` struct. This function takes a vector of `Icon` objects and returns a `Manifest` object.

```rust
pub fn build_manifest(icons: Vec<Icon>) -> Manifest
```

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

### Set Manifest Display Mode

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Manifest.html

Sets the display mode for the web application (e.g., fullscreen, standalone). This is a builder pattern method returning Self.

```rust
pub fn display(self, display: DisplayMode) -> Self
```

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

### Set Manifest Icons

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Manifest.html

Sets the icons for the web application, typically used for shortcuts and favicons. This is a builder pattern method returning Self.

```rust
pub fn icons(self, icons: Vec<Icon>) -> Self
```

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

### Define SHORT_APP_NAME Constant

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/constants/constant.SHORT_APP_NAME.html

This constant defines the short application name used throughout the system. It is declared as a string slice.

```rust
pub const SHORT_APP_NAME: &str = "short name";
```

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

### Set Manifest Short Name

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Manifest.html

Sets a short version of the name for the web application. This is a builder pattern method returning Self.

```rust
pub fn short_name(self, short_name: String) -> Self
```

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

### Set Manifest Background Color

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Manifest.html

Sets the background color for the web application. This is a builder pattern method returning Self.

```rust
pub fn background_color(self, background_color: String) -> Self
```

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

### Set Manifest Theme Color

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Manifest.html

Sets the theme color for the web application. This is a builder pattern method returning Self.

```rust
pub fn theme_color(self, theme_color: String) -> Self
```

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

### Define APP_NAME Constant

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/constants/constant.APP_NAME.html

This constant holds the application's name as a string slice. It is used to identify the application.

```rust
pub const APP_NAME: &str = "app name";
```

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

### Serialize Implementation for Icon

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Serializes the Icon struct into a Serde serializer.

```rust
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
    S: Serializer,
```

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

### Set Manifest Orientation

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Manifest.html

Sets the default orientation for the web application. This is a builder pattern method returning Self.

```rust
pub fn orientation(self, orientation: Orientation) -> Self
```

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

### Set Manifest Name

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Manifest.html

Sets the human-readable name for the web application. This is a builder pattern method returning Self.

```rust
pub fn name(self, name: String) -> Self
```

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

### Implement Into Trait for ManifestBuilder

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/struct.ManifestBuilder.html

Explains the implementation of the `Into` trait for `ManifestBuilder`. This facilitates conversion from `T` to `U` where `U` implements `From<T>`.

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

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

### Implement TryFrom Trait for ManifestBuilder

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/struct.ManifestBuilder.html

Describes the implementation of the `TryFrom` trait for `ManifestBuilder`. This enables fallible conversions from `U` to `T`.

```rust
type Error = Infallible
```

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

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

### Set Manifest Scope

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Manifest.html

Sets the scope of the web application, defining the navigation scope. This is a builder pattern method returning Self.

```rust
pub fn scope(self, scope: String) -> Self
```

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

### Debug Implementation for Icon

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Formats the Icon struct for debugging purposes.

```rust
fn fmt(&self, f: &mut Formatter<'_>) -> Result
```

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

### Implement TryInto Trait for ManifestBuilder

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/struct.ManifestBuilder.html

Details the implementation of the `TryInto` trait for `ManifestBuilder`. This allows fallible conversions from `T` to `U`.

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

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

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

### Generic Pointable Initialization

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Initializes a generic type T using a provided initializer, returning a usize pointer.

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

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

### generate_icons

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/struct.IconGenerator.html

Generates icons from the specified filename. Returns a vector of Icon objects or an IconGenerationError.

```APIDOC
## generate_icons

### Description
Generates icons from the specified filename.

### Method
`pub fn generate_icons(filename: &str) -> Result<Vec<Icon>, IconGenerationError>`

### Parameters
* **filename** (`&str`) - The name of the file to generate icons from.

### Returns
* `Result<Vec<Icon>, IconGenerationError>` - A vector of Icon objects on success, or an IconGenerationError on failure.
```

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

### TryInto::try_into() Implementation

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.DisplayMode.html

Performs the conversion from `T` to `U`. This is part of the generic `TryInto<U>` for `T` implementation.

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

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

### Implement Pointable Trait for ManifestBuilder

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/struct.ManifestBuilder.html

Covers the implementation of the `Pointable` trait for `ManifestBuilder`, including constants and unsafe functions for pointer manipulation and initialization.

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

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

### BACKGROUND_COLOR Constant Definition

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/constants/constant.BACKGROUND_COLOR.html

Defines the default background color as a string literal. This constant is used to set the background color.

```rust
pub const BACKGROUND_COLOR: &str = "#fff";
```

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

### Implementing From<Error> for IconGenerationError

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/enum.IconGenerationError.html

Allows converting an `std::io::Error` into an `IconGenerationError::IoError`. This simplifies error handling by enabling direct conversion from IO operations.

```rust
fn from(e: IoError) -> Self
```

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

### Orientation Enum Definition

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.Orientation.html

Defines the possible orientations for a manifest.

```APIDOC
## Enum Orientation

manifest_gen::domain

### Summary
```rust
pub enum Orientation {
    Any,
    Natural,
    Landscape,
    LandscapePrimary,
    LandscapeSecondary,
    Portrait,
    PortraitPrimary,
    PortraitSecondary,
}
```

## Variants

### Any

### Natural

### Landscape

### LandscapePrimary

### LandscapeSecondary

### Portrait

### PortraitPrimary

### PortraitSecondary
```

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

### TryFrom::try_from() Implementation

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.DisplayMode.html

Performs the conversion from `U` to `T`. This is part of the generic `TryFrom<U>` for `T` implementation.

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

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

### Implementing From<ImageError> for IconGenerationError

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/enum.IconGenerationError.html

Enables conversion of an `ImageError` into an `IconGenerationError::ImageError`. This facilitates seamless integration with image processing libraries.

```rust
fn from(e: ImageError) -> Self
```

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

### ToString::to_string() Implementation

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.DisplayMode.html

Converts the given value to a `String`. This is part of the `ToString` trait implementation.

```rust
fn to_string(&self) -> String
```

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

### Define Manifest Struct

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Manifest.html

Defines the basic structure of the Manifest. This struct holds private fields and is intended to be built using its associated methods.

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

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

### Define THEME_COLOR Constant

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/constants/constant.THEME_COLOR.html

This constant defines the default theme color as a string. It is used to set the primary color theme.

```rust
pub const THEME_COLOR: &str = "#fff";
```

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

### DisplayMode::serialize() for Serialize

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.DisplayMode.html

Serializes the DisplayMode enum into a format compatible with Serde. This allows the enum to be easily converted to formats like JSON.

```rust
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,
```

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

### Generic Into Implementation

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Calls U::from(self) for conversion between generic types T and U, provided U implements From<T>.

```rust
fn into(self) -> U
where
    U: From<T>,
```

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

### Display Orientation

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.Orientation.html

Implements the Display trait for the Orientation enum, allowing it to be formatted as a string. This is useful for logging or user-facing output.

```rust
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult>
```

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

### DisplayMode::default() Function

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.DisplayMode.html

Provides the default value for the DisplayMode enum. This is useful when no specific mode is chosen.

```rust
fn default() -> Self
```

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

### Declare ManifestBuilder Struct

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/struct.ManifestBuilder.html

Defines the ManifestBuilder struct. This is a simple unit struct used as a type marker.

```rust
pub struct ManifestBuilder;
```

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

### Enum Orientation Definition

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.Orientation.html

Defines the possible orientations for a device screen. Use this enum to specify or check the desired screen orientation.

```rust
pub enum Orientation {
    Any,
    Natural,
    Landscape,
    LandscapePrimary,
    LandscapeSecondary,
    Portrait,
    PortraitPrimary,
    PortraitSecondary,
}
```

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

### Icon Struct Definition

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Defines the Icon struct. Its fields are private and not directly accessible.

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

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

### Generate Icons Function

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/struct.IconGenerator.html

The `generate_icons` function is part of the IconGenerator implementation. It takes a filename as input and returns a Result containing a vector of Icons or an IconGenerationError.

```rust
pub fn generate_icons(filename: &str) -> Result<Vec<Icon>, IconGenerationError>
```

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

### Generic TryInto Conversion

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Performs a fallible conversion from type T to type U, where U implements TryFrom<T>.

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

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

### Implementing Error::source for IconGenerationError

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/enum.IconGenerationError.html

Provides access to the underlying error if the `IconGenerationError` was created from another error type. This is useful for inspecting the root cause of an error.

```rust
fn source(&self) -> Option<&(dyn Error + 'static)>
```

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

### Borrow Orientation

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.Orientation.html

Implements immutable borrowing for the Orientation enum. This allows accessing the enum's value without taking ownership.

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

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

### Convert Into Orientation

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.Orientation.html

Implements the Into trait for the Orientation enum, enabling conversion from Orientation into another type U that implements From<Orientation>. This is the inverse of the From trait.

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

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

### Default Orientation

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.Orientation.html

Provides the default value for the Orientation enum. This is typically used when no specific orientation is set.

```rust
fn default() -> Self>
```

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

### Generic TryFrom Conversion

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Performs a fallible conversion from type U to type T, where U implements Into<T>.

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

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

### DISPLAY_MODE Constant Declaration

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/constants/constant.DISPLAY_MODE.html

This is the declaration of the DISPLAY_MODE constant. It indicates the type it represents.

```rust
pub const DISPLAY_MODE: DisplayMode;
```

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

### Generic From Implementation

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Returns the argument unchanged for a generic type T. This is a trivial implementation of the From trait.

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

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

### DisplayMode Enum Definition

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.DisplayMode.html

Defines the possible display modes for a web application.

```rust
pub enum DisplayMode {
    FullScreen,
    Standalone,
    MinimalUI,
    Browser,
}
```

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

### DisplayMode Enum Definition

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.DisplayMode.html

Defines the possible display modes for a web application.

```APIDOC
## Enum DisplayMode

manifest_gen::domain

### Summary
```rust
pub enum DisplayMode {
    FullScreen,
    Standalone,
    MinimalUI,
    Browser,
}
```

### Variants
* FullScreen
* Standalone
* MinimalUI
* Browser
```

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

### Convert From Orientation

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.Orientation.html

Implements the From trait for the Orientation enum, allowing conversion from a type T into Orientation. This is a standard way to create enum variants.

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

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

### Define SCOPE Constant

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/constants/constant.SCOPE.html

This constant defines the root scope path, typically used as a default or base path.

```rust
pub const SCOPE: &str = "/";
```

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

### Dereference Orientation Pointer

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.Orientation.html

Provides a way to dereference a pointer to an Orientation value. This is an unsafe operation and requires careful handling of the pointer.

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

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

### Mutably Dereference Orientation Pointer

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.Orientation.html

Provides a way to mutably dereference a pointer to an Orientation value. This is an unsafe operation and requires careful handling of the pointer.

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

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

### Drop Orientation Pointer

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.Orientation.html

Provides a way to drop the object pointed to by a pointer to an Orientation value. This is an unsafe operation and should be used when the object is no longer needed.

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

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

### Mutably Borrow Orientation

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/enum.Orientation.html

Implements mutable borrowing for the Orientation enum. This allows modifying the enum's value through a mutable reference.

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

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

### Implementing Error::cause (Deprecated)

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/enum.IconGenerationError.html

A deprecated method for retrieving the underlying cause of an error. The `Error::source` method is the preferred alternative as it supports downcasting.

```rust
fn cause(&self) -> Option<&dyn Error>
```

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

### ORIENTATION Constant Declaration

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/constants/constant.ORIENTATION.html

This constant defines the Orientation type. It is used to specify orientation settings.

```rust
pub const ORIENTATION: Orientation;
```

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

### ORIENTATION Constant

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/constants/constant.ORIENTATION.html

The ORIENTATION constant is a public constant defined within the manifest_gen::constants module. Its type is 'Orientation'.

```APIDOC
## ORIENTATION

manifest_gen::constants

### Summary

```rust
pub const ORIENTATION: Orientation;
```
```

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

### DISPLAY_MODE Constant

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/constants/constant.DISPLAY_MODE.html

The DISPLAY_MODE constant is a public constant of type DisplayMode.

```APIDOC
## Constant DISPLAY_MODE

### Summary

```rust
pub const DISPLAY_MODE: DisplayMode;
```

This constant is defined in the `manifest_gen::constants` module and is of type `DisplayMode`.
```

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

### Generic BorrowMut Implementation

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Mutably borrows from an owned value of a generic type T.

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

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

### Generic Borrow Implementation

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Immutably borrows from an owned value of a generic type T.

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

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

### Generic Pointable Drop

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/domain/struct.Icon.html

Drops the object pointed to by a usize pointer for a generic type T.

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

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

### IconGenerationError Enum Definition

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/enum.IconGenerationError.html

Defines the IconGenerationError enum with variants for IO errors and Image errors. Use this enum to handle potential failures in icon generation processes.

```rust
pub enum IconGenerationError {
    IoError(Error),
    ImageError(ImageError),
}
```

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

### IconGenerator Struct Definition

Source: https://docs.rs/manifest-gen/0.2.3/manifest_gen/interactors/struct.IconGenerator.html

Defines the IconGenerator struct, which is an empty struct used as a type for implementing icon generation functionalities.

```rust
pub struct IconGenerator;
```
Tokens:
Raw