Remove deprecated items as part of release 0.9.0.

Question

Remove deprecated items as part of release 0.9.0.

ajrcarey opened this issue 2 years ago · 17 comments

ajrcarey commented 2 years ago

Tracking issue for deprecated items in the pdfium-render high-level interface.

Answer 1 · 2022-07-29T14:39:32.000Z

The following items were deprecated as part of #35:

PdfBitmapConfig struct: replaced by equivalent renamed PdfRenderConfig
PdfPage::get_bitmap() function: replaced by equivalent renamed PdfPage::render()
PdfPage::get_bitmap_with_config() function: replaced by equivalent renamed PdfPage::render_with_config()
PdfBitmap:render() function: no longer necessary since page rendering operations are now processed eagerly rather than lazily. The function is now a no-op.

Answer 2 · 2022-07-30T17:14:46.000Z

The following additional item was deprecated as part of #35:

PdfRenderConfig::rotate_if_portait(): replaced by correctly-spelled equivalent PdfRenderConfig::rotate_if_portrait()

Answer 3 · 2022-09-17T14:25:59.000Z

The following additional items were deprecated as part of #44:

Pdfium::get_bindings(): renamed to Pdfium::bindings()

Answer 4 · 2022-12-18T13:58:14.000Z

The following additional items were deprecated as part of #63:

Pdfium::load_pdf_from_bytes(): renamed to Pdfium::load_pdf_from_byte_slice()

Answer 5 · 2023-02-04T19:42:03.000Z

The following additional items were deprecated as part of #67:

PdfPages::delete_page_at_index(): replaced by memory-safe PdfPage::delete()

Answer 6 · 2023-02-05T14:28:35.000Z

The following additional items were deprecated as part of #67:

PdfPages::delete_page_range(): replaced by memory-safe PdfPage::delete()

Answer 7 · 2023-04-10T20:18:32.000Z

The following additional items were deprecated as part of #79:

PdfFont::new_built_in()
All the PdfFont constructor functions for the 14 built-in PDF font types
PdfFont::load_type1_from_file()
PdfFont::load_type1_from_reader()
PdfFont::load_type1_from_fetch()
PdfFont::load_type1_from_blob()
PdfFont::new_type1_from_bytes()
PdfFont::load_true_type_from_reader()
PdfFont::load_true_type_from_file()
PdfFont::load_true_type_from_reader()
PdfFont::load_true_type_from_fetch()
PdfFont::load_true_type_from_blob()
PdfFont::new_true_type_from_bytes()

All functions were moved into PdfFonts. Additionally, PdfFont::new_type1_from_bytes() and PdfFont::new_true_type_from_bytes() were renamed to PdfFonts::load_type1_from_bytes() and PdfFonts::load_true_type_from_bytes() respectively.

The IntoPdfFontToken trait can probably be removed once these deprecated items are removed, since it will no longer be possible to create a PdfFont instance directly.

Answer 8 · 2023-06-18T23:16:18.000Z

The following additional items were deprecated as part of #90:

PdfBitmapRotation enum: renamed to PdfPageRenderRotation and moved from bitmap.rs into page.rs

Answer 9 · 2023-06-19T21:29:13.000Z

The following additional items were deprecated as part of #90:

PdfColor::SOLID_* consts: renamed to remove the superfluous SOLID_ prefix.

Answer 10 · 2023-07-22T16:11:45.000Z

The following additional items were deprecated as part of #96:

PdfBitmapFormat::BRGx variant: spelling corrected to PdfBitmap::BGRx

Answer 11 · 2023-07-30T17:55:35.000Z

Updated examples/README.md to remove references to PdfFont functions deprecated during #79.

Answer 12 · 2023-07-30T17:56:51.000Z

Updated examples/wasm.rs to remove references to PdfColor values deprecated during #90.

Answer 13 · 2023-11-03T14:44:03.000Z

Adjust function signature of PdfBitmap::as_image() to return Result<DynamicImage, PdfiumError>. This change cannot be easily deprecated; it will be a breaking change instead.

Answer 14 · 2023-11-03T19:18:46.000Z

The following additional items were deprecated as part of #117:

PdfPage::set_matrix_with_clip(): renamed to PdfPage::apply_matrix_with_clip().

Answer 15 · 2023-11-04T15:31:17.000Z

The following additional items were deprecated as part of #117:

set_matrix() in create_transform_setters!() macro: renamed to apply_matrix()

Answer 16 · 2023-11-25T17:35:53.000Z

The following additional items were deprecated as part of #119:

PdfBitmap::as_bytes(): renamed to PdfBitmap::as_raw_bytes().

Answer 17 · 2024-08-04T17:20:41.000Z

Should deprecate all non-idiomatically named get_*() functions in create_transform_getters macro for equivalently named non-get_ functions.

This also affects the get_*() functions in PdfPageTextChar, which follow the same naming as the transform getters but do not use the create_transform_getters macro.

(It wasn't entirely clear to me at a glance why PdfPageTextChar isn't using the create_transform_getters macro, but presumably there's a reason. Could be worth checking to make sure this isn't just an oversight. If there is a reason, it would be good to document this.)