search

esp-rs / espflash

Serial flasher utility for Espressif SoCs and modules based on esptool.py
Apache License 2.0
478 stars 117 forks source link

Public API needs improvements to make it more extensible #474

Closed jessebraham closed 9 months ago

jessebraham commented 1 year ago

There are various public functions in the API, such as load_elf_to_flash, which are not extensible in their current form. These functions should be marked as deprecated and be replaced by functions which are extensible. For instance, by taking a #[non_exhaustive] struct containing the required options.

Since we can deprecate the old functions this can be done in a semver-compatible way. We should identify additional functions which need improving and construct a task list below when able.

SergioGasquez commented 10 months ago

Since we are working towards 3.0 we don't need to deprecate functions, we can just remove them to simplify the codebase.