rpdfium

https://docs.rs/rpdfium
Admin
rpdfium is a faithful Rust port of Google's PDFium PDF rendering engine, providing comprehensive PDF...
Tokens:298,084
Snippets:2,992
Trust Score:9.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example: Opening a PDF file

Source: https://docs.rs/rpdfium/latest/src/rpdfium/lib.rs.html

Demonstrates how to open a PDF document from a file using `Document::open_file`. Ensure you have a `Library` instance and `OpenOptions`.

```rust
let lib = Library::new();
let opts = OpenOptions::default();
let doc = rpdfium::Document::open_file(&lib, "document.pdf", &opts)?;
# Ok::<(), rpdfium::Error>(())
```

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

### Link Text Range

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Link.html

Methods to get the character range (start index and count) of the text associated with the link. `link_get_text_range` is the recommended method.

```APIDOC
/// Return the character range `(start_char_index, char_count)` of this link (upstream `FPDFLink_GetTextRange`).
pub fn text_range(&self) -> (usize, usize)

/// Upstream-aligned alias for `text_range()`.
/// Corresponds to `FPDFLink_GetTextRange`.
pub fn link_get_text_range(&self) -> (usize, usize)

/// 👎Deprecated: 
/// use `link_get_text_range()` — matches upstream `FPDFLink_GetTextRange`
/// Former alias for `text_range()`.
pub fn get_text_range(&self) -> (usize, usize)
```

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

### Get Link Text Range

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Link.html

Retrieves the character range (start index and count) of the link's text. Use `link_get_text_range()` for the upstream-aligned alias.

```rust
pub fn text_range(&self) -> (usize, usize)
```

```rust
pub fn link_get_text_range(&self) -> (usize, usize)
```

```rust
pub fn get_text_range(&self) -> (usize, usize)
```

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

### Create a new Library instance

Source: https://docs.rs/rpdfium/latest/src/rpdfium/lib.rs.html

Initializes a new Library with default system font discovery. This is the standard way to create a library instance for general use.

```rust
pub fn new() -> Self {
        Self {
            _private: (),
            font_mapper: Some(Box::new(FolderFontScanner::new())),
        }
    }
```

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

### Get Print Page Range

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.ViewerPreferences.html

Returns the page ranges to print. Returns None if the /PrintPageRange entry is absent. The range is stored as pairs [start, end] (0-based page indices). Corresponds to CPDF_ViewerPreferences::PrintPageRange() in PDFium.

```rust
pub fn print_page_range(&self) -> Option<&[i64]>
```

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

### Init

Source: https://docs.rs/rpdfium/latest/rpdfium/enum.PdfError.html

The type for initializers.

```APIDOC
## Init

### Description
The type for initializers.

### Type Alias
`Init`

### Associated Type
`T`
```

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

### Get Type ID

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Name.html

Gets the TypeId of the Name type.

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

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

### Default Implementation for OpenOptions

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.OpenOptions.html

Provides the default configuration for opening a PDF document. This is useful when no specific customizations are needed.

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

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

### Unwrapping with expect for environment variables

Source: https://docs.rs/rpdfium/latest/rpdfium/type.PdfResult.html

Demonstrates using `expect` to retrieve an environment variable, providing a clear message about why the variable is expected to exist. This pattern is recommended for clarity when unwrapping potentially missing configuration.

```rust
let path = std::env::var("IMPORTANT_PATH")
    .expect("env variable `IMPORTANT_PATH` should be set by `wrapper_script.sh`");
```

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

### Get TypeId of DocMdpPermission

Source: https://docs.rs/rpdfium/latest/rpdfium/enum.DocMdpPermission.html

Gets the TypeId of the DocMdpPermission enum. This is part of the Any trait implementation.

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

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

### Deprecated Get File Method

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.FileSpec.html

Deprecated method for getting the file data, use `attachment_get_file()` instead.

```rust
pub fn get_file(&self) -> Option<&[u8]>
```

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

### type Init = T

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.PdfString.html

The type for initializers.

```APIDOC
## type Init = T

### Description
The type for initializers.
```

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

### Deprecated Get Name Method

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.FileSpec.html

Deprecated method for getting the attachment name, use `attachment_get_name()` instead.

```rust
pub fn get_name(&self) -> Option<&str>
```

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

### Create OCContext from Catalog

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.OCContext.html

Parses the optional content configuration from a document's catalog. It looks for the `/OCProperties` dictionary and its default configuration (`/D`). Returns `None` if no such properties are found.

```rust
pub fn from_catalog<S>( store: &ObjectStore<S>, catalog_id: ObjectId, ) -> Option<OCContext>
where S: PdfSource,
```

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

### Deprecated Get Subtype Method

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.FileSpec.html

Deprecated method for getting the subtype, use `subtype()` instead. There is no public `FPDFAttachment_GetSubtype` API.

```rust
pub fn get_subtype(&self) -> Option<&str>
```

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

### Create and Use a PDF Name

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Name.html

Demonstrates how to create a Name object from raw bytes and how to retrieve its byte and string representations. The bytes provided should not include the leading '/' delimiter.

```rust
use rpdfium_core::Name;

let name = Name::from_bytes(b"Type".to_vec());
assert_eq!(name.as_bytes(), b"Type");
assert_eq!(name.as_str().as_ref(), "Type");
```

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

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

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.PdfString.html

Initializes a with the given initializer.

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

### Description
Initializes a with the given initializer.

### Parameters
- **init** (*<T as Pointable>::Init*) - The initializer value.

### Returns
- (*usize*) - The pointer to the initialized memory.
```

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

### Get Action Type (Alias)

Source: https://docs.rs/rpdfium/latest/rpdfium/enum.Action.html

An alias for `action_type()`, providing an alternative way to get the coarse `ActionType` classification of an action.

```rust
pub fn action_get_type(&self) -> ActionType
```

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

### Text Get Character Origin

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.TextPage.html

Gets the page-space origin of the character at the specified index. This is an upstream-aligned alias for `char_origin()` and corresponds to `FPDFText_GetCharOrigin`.

```APIDOC
## pub fn text_get_char_origin(&self, index: usize) -> Option<CharOrigin>

### Description
Upstream-aligned alias for `char_origin()`.
Corresponds to `FPDFText_GetCharOrigin`.
```

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

### init

Source: https://docs.rs/rpdfium/latest/rpdfium/enum.PdfError.html

Initializes a type with the given initializer.

```APIDOC
## init

### Description
Initializes a with the given initializer.

### Method
`init`

### Parameters
- `init`: The initializer for the type.

### Returns
The pointer to the initialized memory as a `usize`.
```

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

### Get Object Store Reference

Source: https://docs.rs/rpdfium/latest/src/rpdfium/arc.rs.html

Provides a reference to the underlying object store, which holds document resources.

```rust
pub fn store(&self) -> &ObjectStore<Arc<[u8]>> {
    &self.inner.store
}
```

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

### Get Struct Type

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.StructElement.html

Retrieves the structure type tag of a StructElement. This method is the primary way to get the type, with aliases for compatibility.

```rust
pub fn struct_type(&self) -> &str
```

```rust
pub fn struct_element_get_type(&self) -> &str
```

```rust
pub fn get_type(&self) -> &str
```

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

### Go To

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Name.html

Represents a 'GoTo' action, typically to a specific page or destination.

```APIDOC
## pub fn go_to() -> Name

### Description
Represents a 'GoTo' action, typically to a specific page or destination.

### Endpoint
`/GoTo`
```

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

### Text Get Text Object

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.TextPage.html

Gets the text run ID of the character at the specified index. This is an upstream-aligned alias for `text_object()` and corresponds to `FPDFText_GetTextObject`.

```APIDOC
## pub fn text_get_text_object(&self, index: usize) -> Option<u32>

### Description
Upstream-aligned alias for `text_object()`.
Corresponds to `FPDFText_GetTextObject`.
```

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

### and() Method Examples

Source: https://docs.rs/rpdfium/latest/rpdfium/type.DocResult.html

Demonstrates the `and()` method, which returns the second `Result` if the first is `Ok`, otherwise returns the first `Result`'s `Err`. Arguments are eagerly evaluated.

```rust
let x: Result<u32, &str> = Ok(2);
let y: Result<&str, &str> = Err("late error");
assert_eq!(x.and(y), Err("late error"));
```

```rust
let x: Result<u32, &str> = Err("early error");
let y: Result<&str, &str> = Ok("foo");
assert_eq!(x.and(y), Err("early error"));
```

```rust
let x: Result<u32, &str> = Err("not a 2");
let y: Result<&str, &str> = Err("late error");
assert_eq!(x.and(y), Err("not a 2"));
```

```rust
let x: Result<u32, &str> = Ok(2);
let y: Result<&str, &str> = Ok("different result type");
assert_eq!(x.and(y), Ok("different result type"));
```

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

### Text Get Character Box

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.TextPage.html

Gets the tight bounding box of the character at the specified index. This is an upstream-aligned alias for `char_box()` and corresponds to `FPDFText_GetCharBox`.

```APIDOC
## pub fn text_get_char_box(&self, index: usize) -> Option<CharRect>

### Description
Upstream-aligned alias for `char_box()`.
Corresponds to `FPDFText_GetCharBox`.
```

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

### DisplayVisitor: visit_image method

Source: https://docs.rs/rpdfium/latest/rpdfium/trait.DisplayVisitor.html

Called for each image node in the display tree. Includes image reference, transformation matrix, and color information.

```rust
fn visit_image(
        &mut self,
        image_ref: &ImageRef,
        matrix: &Matrix,
        mask: Option<&ImageMask>,
        fill_color: Option<&Color>,
        transfer_function: Option<&TransferFunction>,
    );
```

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

### Text Get Loose Character Box

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.TextPage.html

Gets the loose bounding box of the character at the specified index. This is an upstream-aligned alias for `loose_char_box()` and corresponds to `FPDFText_GetLooseCharBox`.

```APIDOC
## pub fn text_get_loose_char_box(&self, index: usize) -> Option<CharRect>

### Description
Upstream-aligned alias for `loose_char_box()`.
Corresponds to `FPDFText_GetLooseCharBox`.
```

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

### Library Initialization

Source: https://docs.rs/rpdfium/latest/src/rpdfium/lib.rs.html

Provides methods for creating and configuring the RPDFium Library instance, which is essential for all PDF operations.

```APIDOC
## Library

### Description
The top-level library instance. In the lifetime-based API, all documents and pages borrow from the `Library`, ensuring they cannot outlive the engine context.

### Methods

#### `new()`

- **Description**: Create a new `Library` instance with default system font discovery.
- **Returns**: A new `Library` instance.

#### `with_font_mapper(mapper: Box<dyn FontMapper>)`

- **Description**: Create a `Library` with a custom font mapper. Use this for WASM targets, embedded systems, or when you want to provide fonts from a custom source.
- **Parameters**:
  - `mapper` (Box<dyn FontMapper>) - The custom font mapper to use.
- **Returns**: A new `Library` instance with the custom font mapper.

#### `font_mapper(&self) -> Option<&dyn FontMapper>`

- **Description**: Returns a reference to the font mapper, if configured.
- **Returns**: An `Option` containing a reference to the `FontMapper` if one is set, otherwise `None`.
```

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

### Deprecated Get Underlying Bytes Method

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.FileSpec.html

Deprecated method for getting the raw file bytes, use `underlying_bytes()` instead. There is no public `FPDF_*` API for this.

```rust
pub fn get_underlying_bytes(&self) -> Option<&[u8]>
```

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

### Size::new

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Size.html

Creates a new Size instance with the specified width and height.

```APIDOC
### impl Size

#### pub fn new(width: f64, height: f64) -> Size

Create a new size.
```

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

### Text Get Matrix

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.TextPage.html

Gets the text matrix `[a, b, c, d, e, f]` of the character at the specified index. This is an upstream-aligned alias for `matrix()` and corresponds to `FPDFText_GetMatrix`.

```APIDOC
## pub fn text_get_matrix(&self, index: usize) -> Option<[f32; 6]>

### Description
Upstream-aligned alias for `matrix()`.
Corresponds to `FPDFText_GetMatrix`.
```

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

### DisplayVisitor: visit_path method

Source: https://docs.rs/rpdfium/latest/rpdfium/trait.DisplayVisitor.html

Called for each path node encountered in the display tree. Provides details about the path operations, style, and colors.

```rust
fn visit_path(
        &mut self,
        ops: &[PathOp],
        style: &PathStyle,
        matrix: &Matrix,
        fill_color: Option<&Color>,
        stroke_color: Option<&Color>,
        fill_color_space: Option<&ColorSpaceFamily>,
        stroke_color_space: Option<&ColorSpaceFamily>,
        transfer_function: Option<&TransferFunction>,
        overprint: bool,
        overprint_mode: u32,
    );
```

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

### OpenOptions Builder Methods

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.OpenOptions.html

Methods for configuring OpenOptions, allowing for a fluent builder pattern.

```APIDOC
### impl OpenOptions

#### pub fn with_parsing_mode(self, mode: ParsingMode) -> OpenOptions

Set the parsing mode.

#### pub fn with_password(self, password: impl Into<String>) -> OpenOptions

Set the password for encrypted documents.

#### pub fn with_max_decompressed_stream_size(self, size: u64) -> OpenOptions

Set the maximum decompressed stream size in bytes.

#### pub fn with_max_compression_ratio(self, ratio: u32) -> OpenOptions

Set the maximum compression ratio before aborting.

#### pub fn with_max_operators_per_page(self, count: u64) -> OpenOptions

Set the maximum content stream operators per page.

#### pub fn with_max_endstream_scan_distance(self, distance: u64) -> OpenOptions

Set the maximum distance to scan for `endstream`.
```

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

### Get Annotation Count

Source: https://docs.rs/rpdfium/latest/src/rpdfium/lib.rs.html

Returns the total number of annotations present on the current PDF page. This method is an alias for calling `annotations()` and then getting the length of the resulting vector.

```APIDOC
## annotation_count

### Description
Returns the number of annotations on this page.

Corresponds to `FPDFPage_GetAnnotCount`.

### Method
`pub fn annotation_count(&self) -> Result<usize>`

### Response
- `Result<usize>`: The count of annotations on the page, or an error.
```

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

### RgbaColor Conversions

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.RgbaColor.html

Demonstrates how to convert RgbaColor instances into Either variants based on a condition.

```APIDOC
## fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>

### Description
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.

### Parameters
- `into_left`: A closure that takes a reference to `self` and returns a boolean. If `true`, `self` becomes `Left`; otherwise, it becomes `Right`.

### Returns
- `Either<Self, Self>`: An `Either` enum containing either the `Left` or `Right` variant of the original `RgbaColor`.
```

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

### Text Get Character Angle

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.TextPage.html

Gets the rotation angle of the character at the specified index in radians, normalized to `[0, 2*PI)`. This is an upstream-aligned alias for `char_angle()` and corresponds to `FPDFText_GetCharAngle`.

```APIDOC
## pub fn text_get_char_angle(&self, index: usize) -> Option<f32>

### Description
Upstream-aligned alias for `char_angle()`.
Corresponds to `FPDFText_GetCharAngle`.
```

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

### type_id

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.StructTree.html

Gets the `TypeId` of `self`.

```APIDOC
## fn type_id(&self) -> TypeId

### Description
Gets the `TypeId` of `self`.

### Method
`type_id`

### Parameters
- `self` (*self*) - The instance of the struct.

### Returns
- `TypeId` - The type identifier of the struct.
```

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

### try_from

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.StructTree.html

Performs the conversion.

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

### Description
Performs the conversion.

### Method
`try_from`

### Parameters
- `value` (*U*) - The value to convert.

### Returns
- `Result<T, <T as TryFrom<U>>::Error>` - The result of the conversion.
```

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

### GetTypeId

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.ElementsForPage.html

Gets the `TypeId` of `self`.

```APIDOC
## fn type_id(&self) -> TypeId

### Description
Gets the `TypeId` of `self`.

### Returns
The `TypeId` of the object.
```

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

### Color Creation Methods

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Color.html

Provides static methods to create Color instances for different color spaces.

```APIDOC
## Implementations for Color

### `impl Color`

#### `pub fn gray(g: f32) -> Color`
Create a gray color (DeviceGray).
```

```APIDOC
#### `pub fn rgb(r: f32, g: f32, b: f32) -> Color`
Create an RGB color (DeviceRGB).
```

```APIDOC
#### `pub fn cmyk(c: f32, m: f32, y: f32, k: f32) -> Color`
Create a CMYK color (DeviceCMYK).
```

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

### Get Document

Source: https://docs.rs/rpdfium/latest/src/rpdfium/arc.rs.html

Returns a reference to the parent document.

```APIDOC
## document

### Description
Returns a reference to the parent document.

### Method
`document(&self) -> &ArcDocument`
```

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

### Create a New Bitmap

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Bitmap.html

Initializes a new bitmap with specified dimensions and format, filled with zero values. Use this for creating blank image buffers.

```rust
pub fn new(width: u32, height: u32, format: BitmapFormat) -> Bitmap
```

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

### CloneToUninit DocMdpPermission (Nightly)

Source: https://docs.rs/rpdfium/latest/rpdfium/enum.DocMdpPermission.html

Nightly-only experimental API. Performs copy-assignment from self to an uninitialized destination.

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

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

### Get Page Index

Source: https://docs.rs/rpdfium/latest/src/rpdfium/arc.rs.html

Returns the zero-based index of the page.

```rust
    /// Returns the zero-based page index.
    pub fn index(&self) -> u32 {
        self.page_index
    }
```

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

### into_ok

Source: https://docs.rs/rpdfium/latest/rpdfium/type.DocResult.html

Returns the contained Ok value, never panics. This is a nightly-only experimental API.

```APIDOC
## into_ok

### Description
Returns the contained `Ok` value, but never panics. This method is known to never panic on the result types it is implemented for, making it a maintainability safeguard.

### Method
`into_ok()`

### Constraints
Requires `E: Into<!>`.

### Experimental
This is a nightly-only experimental API.

### Examples
```rust
fn only_good_news() -> Result<String, !> {
    Ok("this is fine".into())
}

let s: String = only_good_news().into_ok();
println!("{s}");
```
```

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

### deref_mut

Source: https://docs.rs/rpdfium/latest/rpdfium/enum.PdfError.html

Dereferences a pointer to get a mutable reference to the value.

```APIDOC
## deref_mut

### Description
Mutably dereferences the given pointer.

### Method
`deref_mut`

### Parameters
- `ptr`: The pointer (as a `usize`) to mutably dereference.

### Returns
A mutable reference (`&'a mut T`) to the value at the given pointer.
```

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

### Build Minimal PDF for Testing

Source: https://docs.rs/rpdfium/latest/src/rpdfium/lib.rs.html

Constructs a minimal single-page PDF document with a valid cross-reference table. Useful for testing PDF parsing and validation logic.

```rust
fn minimal_pdf() -> Vec<u8> {
        let mut pdf = Vec::new();
        pdf.extend_from_slice(b"%PDF-1.4\n");
        let off1 = pdf.len();
        pdf.extend_from_slice(b"1 0 obj\n<< /Type /Catalog /Pages 2 0 R >>\nendobj\n");
        let off2 = pdf.len();
        pdf.extend_from_slice(b"2 0 obj\n<< /Type /Pages /Kids [3 0 R] /Count 1 >>\nendobj\n");
        let off3 = pdf.len();
        pdf.extend_from_slice(
            b"3 0 obj\n<< /Type /Page /Parent 2 0 R /MediaBox [0 0 612 792] >>\nendobj\n",
        );
        let xref_offset = pdf.len();
        pdf.extend_from_slice(b"xref\n0 4\n");
        pdf.extend_from_slice(b"0000000000 65535 f \r\n");
        pdf.extend_from_slice(format!("{:010} 00000 n \r\n", off1).as_bytes());
        pdf.extend_from_slice(format!("{:010} 00000 n \r\n", off2).as_bytes());
        pdf.extend_from_slice(format!("{:010} 00000 n \r\n", off3).as_bytes());
        pdf.extend_from_slice(b"trailer\n<< /Size 4 /Root 1 0 R >>\n");
        pdf.extend_from_slice(format!("startxref\n{xref_offset}\n%%EOF").as_bytes());
        pdf
    }
```

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

### deref

Source: https://docs.rs/rpdfium/latest/rpdfium/enum.PdfError.html

Dereferences a pointer to get an immutable reference to the value.

```APIDOC
## deref

### Description
Dereferences the given pointer.

### Method
`deref`

### Parameters
- `ptr`: The pointer (as a `usize`) to dereference.

### Returns
An immutable reference (`&'a T`) to the value at the given pointer.
```

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

### Matrix::new

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Matrix.html

Creates a new Matrix instance by providing all six transformation components.

```APIDOC
### `Matrix::new(a: f64, b: f64, c: f64, d: f64, e: f64, f: f64) -> Matrix`

Create a new matrix from its six components.
```

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

### Page Rotation

Source: https://docs.rs/rpdfium/latest/rpdfium/arc/struct.ArcPage.html

Method to get the current rotation of the page.

```APIDOC
## get_page_rotation

### Description
Deprecated — use `page_get_rotation()`.
Corresponds to `FPDFPage_GetRotation`.

### Method
`get_page_rotation(&self) -> Result<u32>`
```

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

### OpenOptions

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.OpenOptions.html

Configuration options for opening PDF documents.

```APIDOC
## struct OpenOptions

Options for opening a PDF document.

### Methods

#### fn new() -> OpenOptions

Creates a new `OpenOptions` with default values.

#### fn permissions(self, permissions: Permissions) -> OpenOptions

Sets the permissions for the PDF document.

#### fn disable_annotations(self) -> OpenOptions

Disables annotations in the PDF document.

#### fn disable_form_fill(self) -> OpenOptions

Disables form filling in the PDF document.

#### fn disable_links(self) -> OpenOptions

Disables links in the PDF document.

#### fn disable_text_select(self) -> OpenOptions

Disables text selection in the PDF document.

#### fn disable_text_search(self) -> OpenOptions

Disables text search in the PDF document.

#### fn disable_accessibility(self) -> OpenOptions

Disables accessibility features in the PDF document.

#### fn disable_printing(self) -> OpenOptions

Disables printing of the PDF document.

#### fn disable_copy(self) -> OpenOptions

Disables copying of content from the PDF document.

#### fn disable_save(self) -> OpenOptions

Disables saving of the PDF document.

#### fn disable_rotate(self) -> OpenOptions

Disables rotation of pages in the PDF document.

#### fn disable_zoom(self) -> OpenOptions

Disables zooming in the PDF document.

#### fn disable_panning(self) -> OpenOptions

Disables panning of pages in the PDF document.

#### fn disable_all(self) -> OpenOptions

Disables all interactive features in the PDF document.

#### fn load_from_file<P: AsRef<Path>>(self, path: P) -> Result<Document, FpdfError>

Loads a PDF document from a file path.

#### fn load_from_bytes(self, bytes: &[u8]) -> Result<Document, FpdfError>

Loads a PDF document from a byte slice.
```

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

### Get Document Reference

Source: https://docs.rs/rpdfium/latest/src/rpdfium/arc.rs.html

Returns a reference to the parent document of the page.

```rust
    /// Returns a reference to the parent document.
    pub fn document(&self) -> &ArcDocument {
        &self.doc
    }
```

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

### Parent Index

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.StructElement.html

Methods to get the index of a StructElement within its parent.

```APIDOC
## pub fn parent_index(&self) -> Option<usize>

### Description
Returns the zero-based index of this element within its parent’s `children` list, or `None` if this element is a root element (a direct child of `StructTree`).
Use this together with the parent `StructElement` to navigate upward in the tree. Root elements return `None` — they have no parent.
Corresponds to upstream `FPDF_StructElement_GetParent`.

### Returns
- `Option<usize>`: An optional `usize` representing the index within the parent, or `None` for root elements.
```

```APIDOC
## pub fn struct_element_get_parent(&self) -> Option<usize>

### Description
ADR-019 Tier 2 alias for `parent_index()`.
Returns the zero-based index of this element within its parent’s `children` list, or `None` for root elements.
Note: the rpdfium tree model stores elements by value, so this returns an index rather than a handle. Use this index together with the parent node to navigate upward in the tree.
Corresponds to upstream `FPDF_StructElement_GetParent`.

### Returns
- `Option<usize>`: An optional `usize` representing the index within the parent, or `None` for root elements.
```

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

### Create New Size Instance

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Size.html

Constructs a new Size instance with specified width and height.

```rust
pub fn new(width: f64, height: f64) -> Size
```

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

### Basic unwrap() Usage

Source: https://docs.rs/rpdfium/latest/rpdfium/type.DocResult.html

Demonstrates the basic usage of `unwrap()` to get the value from an `Ok` variant. Panics if the `Result` is an `Err`.

```rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.unwrap(), 2);
```

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

### Child Count

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.StructElement.html

Methods to get the number of direct children of a StructElement.

```APIDOC
## pub fn child_count(&self) -> usize

### Description
Returns the number of direct children of this element.
Corresponds to upstream `FPDF_StructElement_CountChildren`.

### Returns
- `usize`: The number of children.
```

```APIDOC
## pub fn struct_element_count_children(&self) -> usize

### Description
ADR-019 Tier 2 alias for `child_count()`.
Corresponds to upstream `FPDF_StructElement_CountChildren`.

### Returns
- `usize`: The number of children.
```

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

### Create New PdfVersion Instance

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.PdfVersion.html

Constructs a new PdfVersion instance with specified major and minor version numbers.

```rust
pub fn new(major: u8, minor: u8) -> PdfVersion
```

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

### Document::page

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Document.html

Gets a page by its zero-based index. Corresponds to `FPDF_LoadPage`.

```APIDOC
## pub fn page(&self, index: u32) -> Result<Page<'_>>

Get a page by its zero-based index.
```

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

### render

Source: https://docs.rs/rpdfium/latest/index.html

Renders a display tree to a bitmap using the default backend.

```APIDOC
## render

### Description
Render a display tree to a bitmap using the default backend.

### Method
N/A (Function)

### Parameters
N/A

### Returns
N/A
```

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

### Get Usage Type

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.OCContext.html

Retrieves the usage type associated with this `OCContext`.

```rust
pub fn usage_type(&self) -> UsageType
```

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

### Get Reference ObjectId

Source: https://docs.rs/rpdfium/latest/rpdfium/enum.Object.html

Safely retrieve the `ObjectId` if the Object is `Reference`.

```rust
pub fn as_reference(&self) -> Option<ObjectId>
```

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

### Create a New White Bitmap

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Bitmap.html

Initializes a new bitmap with specified dimensions and format, filled with white (0xFF for all channels).

```rust
pub fn new_white(width: u32, height: u32, format: BitmapFormat) -> Bitmap
```

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

### Library Creation

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Library.html

Provides methods to create a new Library instance, either with default system font discovery or a custom font mapper.

```APIDOC
## pub fn new() -> Self

Create a new `Library` instance with default system font discovery.

## pub fn with_font_mapper(mapper: Box<dyn FontMapper>) -> Self

Create a `Library` with a custom font mapper.
Use this for WASM targets, embedded systems, or when you want to provide fonts from a custom source.
```

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

### get_font_flags

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.TextPage.html

Deprecated method to get font flags. Use `font_flags()` directly.

```APIDOC
## pub fn get_font_flags(&self, index: usize) -> Option<u32>

### Description
Deprecated: use `font_flags()` directly; no upstream `FPDFText_GetFontFlags()` method exists.

### Parameters
* `index` (usize) - The index of the character.

### Returns
An `Option<u32>` representing the font flags, or `None` if the index is out of bounds.
```

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

### DisplayVisitor: visit_pattern_fill method

Source: https://docs.rs/rpdfium/latest/rpdfium/trait.DisplayVisitor.html

Called for pattern fill nodes, which use tiling patterns to fill areas in the display tree.

```rust
fn visit_pattern_fill(
        &mut self,
        path_ops: &[PathOp],
        fill_rule: FillRule,
        pattern: &TilingPattern,
        pattern_tree: &DisplayTree,
        fill_color: Option<&Color>,
        matrix: &Matrix,
    );
```

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

### get_font_weight

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.TextPage.html

Deprecated method to get the font weight. Use `text_get_font_weight()` instead.

```APIDOC
## pub fn get_font_weight(&self, index: usize) -> Option<i32>

### Description
Deprecated since 0.1.0: Use `text_get_font_weight()` (upstream `FPDFText_GetFontWeight`).

### Parameters
* `index` (usize) - The index of the character.

### Returns
An `Option<i32>` representing the font weight, or `None` if the index is out of bounds.
```

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

### get_stroke_color

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.TextPage.html

Deprecated method to get the stroke color. Use `text_get_stroke_color()` instead.

```APIDOC
## pub fn get_stroke_color(&self, index: usize) -> Option<&Color>

### Description
Deprecated since 0.1.0: Use `text_get_stroke_color()` (upstream `FPDFText_GetStrokeColor`).

### Parameters
* `index` (usize) - The index of the character.

### Returns
An `Option<&Color>` representing the stroke color, or `None` if the index is out of bounds.
```

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

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

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.PdfString.html

This is a nightly-only experimental API. Performs copy-assignment from `self` to `dest`.

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

### Description
This is a nightly-only experimental API. Performs copy-assignment from `self` to `dest`.

### Safety
This function is unsafe because it performs a raw pointer copy. The caller must ensure that `dest` is a valid, mutable pointer to a buffer of sufficient size to hold the data being copied, and that no other references to the data exist during the copy operation.
```

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

### get_fill_color

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.TextPage.html

Deprecated method to get the fill color. Use `text_get_fill_color()` instead.

```APIDOC
## pub fn get_fill_color(&self, index: usize) -> Option<&Color>

### Description
Deprecated since 0.1.0: Use `text_get_fill_color()` (upstream `FPDFText_GetFillColor`).

### Parameters
* `index` (usize) - The index of the character.

### Returns
An `Option<&Color>` representing the fill color, or `None` if the index is out of bounds.
```

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

### Launch

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Name.html

Represents a 'Launch' action, typically to open a file or URL.

```APIDOC
## pub fn launch() -> Name

### Description
Represents a 'Launch' action, typically to open a file or URL.

### Endpoint
`/Launch`
```

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

### CloneToUninit for NameTree

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.NameTree.html

Nightly-only experimental API for cloning NameTree into uninitialized memory.

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

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

### Attribute Count

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.StructElement.html

Methods to get the number of attribute dictionaries associated with a StructElement.

```APIDOC
## pub fn attribute_count(&self) -> usize

### Description
Returns the number of attribute dictionaries associated with this element.
Corresponds to upstream `FPDF_StructElement_GetAttributeCount`.

### Returns
- `usize`: The number of attribute dictionaries.
```

```APIDOC
## pub fn struct_element_get_attribute_count(&self) -> usize

### Description
ADR-019 Tier 2 alias for `attribute_count()`.
Corresponds to upstream `FPDF_StructElement_GetAttributeCount`.

### Returns
- `usize`: The number of attribute dictionaries.
```

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

### Bookmark Methods

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Bookmark.html

Provides methods to access bookmark properties like title, destination, action, and children, as well as navigate the bookmark tree.

```APIDOC
## impl Bookmark

### Methods
- `title(&self) -> &str` - Returns the visible title of this bookmark.
- `bookmark_get_title(&self) -> &str` - Alias for `title()`.
- `get_title(&self) -> &str` - Deprecated: use `bookmark_get_title()`.
- `first_child(&self) -> Option<&Bookmark>` - Returns the first child bookmark, if any.
- `bookmark_get_first_child(&self) -> Option<&Bookmark>` - Alias for `first_child()`.
- `get_first_child(&self) -> Option<&Bookmark>` - Deprecated: use `bookmark_get_first_child()`.
- `count(&self) -> i32` - Returns the count of direct children.
- `bookmark_get_count(&self) -> i32` - Alias for `count()`.
- `get_count(&self) -> i32` - Deprecated: use `bookmark_get_count()`.
- `dest(&self) -> Option<&Destination>` - Returns the destination associated with this bookmark, if any.
- `bookmark_get_dest(&self) -> Option<&Destination>` - Alias for `dest()`.
- `get_dest(&self) -> Option<&Destination>` - Deprecated: use `bookmark_get_dest()`.
- `action(&self) -> Option<&Action>` - Returns the action associated with this bookmark, if any.
- `bookmark_get_action(&self) -> Option<&Action>` - Alias for `action()`.
- `get_action(&self) -> Option<&Action>` - Deprecated: use `bookmark_get_action()`.
- `next_sibling_in<'a>(&self, siblings: &'a [Bookmark]) -> Option<&'a Bookmark>` - Returns the next sibling of this bookmark within `siblings`.
- `bookmark_get_next_sibling<'a>(&self, siblings: &'a [Bookmark]) -> Option<&'a Bookmark>` - Alias for `next_sibling_in()`.
- `get_next_sibling_in<'a>(&self, siblings: &'a [Bookmark]) -> Option<&'a Bookmark>` - Deprecated: use `bookmark_get_next_sibling()`.
```

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

### Get Page Label

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Document.html

Retrieves the label for a specific page, corresponding to FPDF_GetPageLabel.

```APIDOC
## pub fn get_page_label(&self, page_index: u32) -> Result<Option<String>>

### Description
ADR-019 alias for `page_label()`.
Corresponds to `FPDF_GetPageLabel`.

### Parameters
* `page_index` (u32) - The index of the page for which to retrieve the label.

### Returns
* `Result<Option<String>>` - An `Option` containing the page label string if found, otherwise `None`.
```

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

### Bitmap::scanline

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Bitmap.html

Gets a reference to a row of pixel data by scanline index.

```APIDOC
## Bitmap::scanline

### Description
Get a row of pixel data by scanline index.
Corresponds to `CFX_DIBBase::GetScanline()` in PDFium.

### Signature
```rust
pub fn scanline(&self, y: u32) -> &[u8]
```

### Panics
Panics if `y >= self.height`.
```

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

### Clone to Uninit (Experimental)

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Name.html

Performs copy-assignment from the Name value to an uninitialized memory location. This is an experimental API.

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

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

### Get Array Slice

Source: https://docs.rs/rpdfium/latest/rpdfium/enum.Object.html

Safely retrieve a slice of Objects if the Object is `Array`.

```rust
pub fn as_array(&self) -> Option<&[Object]>
```

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

### into_ok

Source: https://docs.rs/rpdfium/latest/rpdfium/type.PdfResult.html

Returns the contained Ok value, never panics. This is an experimental API.

```APIDOC
## into_ok

### Description
Returns the contained `Ok` value, but never panics. Unlike `unwrap`, this method is known to never panic on the result types it is implemented for. Therefore, it can be used instead of `unwrap` as a maintainability safeguard that will fail to compile if the error type of the `Result` is later changed to an error that can actually occur.

### Method
`into_ok()`

### Constraints
Requires `E: Into<!>`.

### Note
This is a nightly-only experimental API.

### Examples
```rust
fn only_good_news() -> Result<String, !> {
    Ok("this is fine".into())
}

let s: String = only_good_news().into_ok();
println!("{s}");
```
```

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

### Get Name Value

Source: https://docs.rs/rpdfium/latest/rpdfium/enum.Object.html

Safely retrieve a reference to the `Name` if the Object is `Name`.

```rust
pub fn as_name(&self) -> Option<&Name>
```

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

### RenderConfig Methods

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.RenderConfig.html

Methods for configuring RenderConfig.

```APIDOC
## impl RenderConfig

### Methods
*   `pub fn with_size(self, width: u32, height: u32) -> RenderConfig` - Set the output dimensions in pixels.
*   `pub fn with_background(self, bg: RgbaColor) -> RenderConfig` - Set the background color.
*   `pub fn with_media_box(self, media_box: Rect) -> RenderConfig` - Set the page media box for coordinate transformation.
*   `pub fn with_rotation(self, rotation: u32) -> RenderConfig` - Set the page rotation in degrees (0, 90, 180, or 270).
*   `pub fn with_tile_size(self, size: u32) -> RenderConfig` - Set the tile size in pixels for progressive rendering.
*   `pub fn with_progress(self, progress: Arc<dyn RenderProgress>) -> RenderConfig` - Set the progress callback for tile-based rendering.
*   `pub fn with_grayscale(self, grayscale: bool) -> RenderConfig` - Enable or disable grayscale output conversion.
*   `pub fn with_antialiasing(self, antialiasing: bool) -> RenderConfig` - Enable or disable anti-aliasing.
*   `pub fn with_text_antialiasing(self, aa: bool) -> RenderConfig` - Enable or disable anti-aliasing specifically for text rendering.
*   `pub fn with_path_antialiasing(self, aa: bool) -> RenderConfig` - Enable or disable anti-aliasing specifically for path/vector rendering.
*   `pub fn with_image_antialiasing(self, aa: bool) -> RenderConfig` - Enable or disable anti-aliasing specifically for image scaling.
```

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

### TryInto Conversion

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Size.html

Demonstrates the `try_into` method for converting between types, which may result in an error.

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

Performs the conversion. This method attempts to convert the current type into another type `U` that implements `TryFrom`. It returns a `Result` which is either the converted value or an error if the conversion fails.
```

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

### Get Zoom Mode (Deprecated)

Source: https://docs.rs/rpdfium/latest/rpdfium/enum.Destination.html

Deprecated: Use zoom_mode(). Non-upstream alias.

```rust
pub fn get_zoom_mode(&self) -> u32
```

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

### Get Location in Page (Alias)

Source: https://docs.rs/rpdfium/latest/rpdfium/enum.Destination.html

An alias for location_in_page(), matching the upstream FPDFDest_GetLocationInPage.

```rust
pub fn dest_get_location_in_page( &self, ) -> Option<(Option<f32>, Option<f32>, Option<f32>)>
```

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

### Pointable Init for DocMdpPermission

Source: https://docs.rs/rpdfium/latest/rpdfium/enum.DocMdpPermission.html

Initializes a DocMdpPermission with the given initializer. Part of the Pointable trait.

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

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

### Get Destination View (Alias)

Source: https://docs.rs/rpdfium/latest/rpdfium/enum.Destination.html

An alias for view(), matching the upstream FPDFDest_GetView.

```rust
pub fn dest_get_view(&self) -> Option<&PageFit>
```

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

### Cloning

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.Bookmark.html

Provides methods for cloning and creating owned data from the Bookmark struct.

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

Performs copy-assignment from `self` to `dest`.
```

```APIDOC
## fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning.
```

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

Uses borrowed data to replace owned data, usually by cloning.
```

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

### Pointable

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.TextPageFind.html

Provides methods for managing pointers, including initialization, dereferencing, and dropping.

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

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

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

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

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

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

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

### TextPageFind::sch_result_index

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.TextPageFind.html

Returns the character start index of the last found match.

```APIDOC
## TextPageFind::sch_result_index

### Description
Returns the character start index of the last found match.
This is the index into the text page’s character array where the most recent search match begins. See also `text_get_sch_result_index()` — the upstream-aligned alias.

### Signature
```rust
pub fn sch_result_index(&self) -> usize
```
```

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

### into_ok() Usage (Nightly)

Source: https://docs.rs/rpdfium/latest/rpdfium/type.DocResult.html

An experimental nightly-only API that returns the contained `Ok` value without panicking. It is a compile-time safeguard against Results that cannot fail.

```rust
fn only_good_news() -> Result<String, !> {
    Ok("this is fine".into())
}

let s: String = only_good_news().into_ok();
println!("{s}");
```

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

### Page Size by Index

Source: https://docs.rs/rpdfium/latest/src/rpdfium/lib.rs.html

Gets the dimensions (width and height) of a page at a specific index.

```APIDOC
## page_size_by_index

### Description
Returns the page dimensions (width, height) at the given zero-based page index as `f64` values.

### Parameters
#### Path Parameters
- **index** (u32) - Required - The zero-based index of the page.

### Returns
- `Result<(f64, f64)>`: A tuple containing the width and height of the page as `f64`.
```

```APIDOC
## get_page_size_by_index

### Description
Upstream-aligned alias for `page_size_by_index()`.

### Parameters
#### Path Parameters
- **index** (u32) - Required - The zero-based index of the page.

### Returns
- `Result<(f64, f64)>`: Same as `page_size_by_index()`.
```

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

### Create ArcLibrary Instance

Source: https://docs.rs/rpdfium/latest/src/rpdfium/arc.rs.html

Instantiates a new `ArcLibrary` which is an Arc-wrapped library instance suitable for WASM/async contexts. It implements `Default`.

```rust
impl ArcLibrary {
    /// Create a new `ArcLibrary` instance.
    pub fn new() -> Self {
        Self {
            inner: Arc::new(LibraryInner { _private: () }),
        }
    }
}

impl Default for ArcLibrary {
    fn default() -> Self {
        Self::new()
    }
}
```

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

### get_text_render_mode

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.TextPage.html

Deprecated method for getting text rendering mode. Use `char_render_mode()` instead.

```APIDOC
## pub fn get_text_render_mode(&self, index: usize) -> Option<TextRenderingMode>

### Description
Deprecated: use `char_render_mode()` — no public `FPDFText_GetTextRenderMode`; for page-object API see `text_obj_get_text_render_mode()` on TextObject.

### Parameters
* `index` (usize) - The index of the character.

### Returns
An `Option<TextRenderingMode>` representing the rendering mode, or `None` if the index is out of bounds.
```

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

### try_into

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.StructTree.html

Performs the conversion.

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

### Description
Performs the conversion.

### Method
`try_into`

### Parameters
- `self` (*self*) - The value to convert.

### Returns
- `Result<U, <U as TryFrom<T>>::Error>` - The result of the conversion.
```

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

### text_get_text_render_mode

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.TextPage.html

Deprecated method for getting text rendering mode. Use `char_render_mode()` instead.

```APIDOC
## pub fn text_get_text_render_mode(&self, index: usize) -> Option<TextRenderingMode>

### Description
Deprecated: use `char_render_mode()` — no public `FPDFText_GetTextRenderMode`; for page-object API see `text_obj_get_text_render_mode()` on TextObject.

### Parameters
* `index` (usize) - The index of the character.

### Returns
An `Option<TextRenderingMode>` representing the rendering mode, or `None` if the index is out of bounds.
```

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

### font_flags

Source: https://docs.rs/rpdfium/latest/rpdfium/struct.TextPage.html

Gets the font descriptor flags of the character at the specified index. This is a sub-value of `text_get_font_info()`.

```APIDOC
## pub fn font_flags(&self, index: usize) -> Option<u32>

### Description
Get the font descriptor flags of the character at `index` (upstream `FPDFText_GetFontInfo` flags output parameter).

### Parameters
* `index` (usize) - The index of the character.

### Returns
An `Option<u32>` representing the font flags, or `None` if the index is out of bounds.
```
Tokens:
Raw