fix: panic caused by defmt forwarding

[optlink]

This is a particularly nasty issue that I spent several days tracking down. See knurling-rs/defmt#723 for another example.

[BartMassey]

We talked about this at the REWG meeting today. First, sincere apologies for being so slow to act on this. It really slipped through the cracks.

Is this panic still reproducible or has it been fixed in defmt since? The patch certainly looks fine and we'll take it unless it's now redundant.

Thanks for looking into this!

[optlink]

I will be revisiting the project where I am using nb in March so I'll have a chance to reproduce it then. Though based on the comments and documentation in the linked issue it seems like this is intended behavior for defmt and so the patch is still required.

[jannic]

This bug is still reproducible. I struggled to trigger it at first, because this works just fine:

    struct My {}

    impl defmt::Format for My {
        fn format(&self, f: defmt::Formatter<'_>) {
            defmt::write!(f, "some logging");
        }
    }

    let s = My {};
    let e = nb::Error::Other(s);
    defmt::info!("Error: {}", e);

However, if I don't implement defmt::Format manually, but use the derive macro, I can reproduce the panic:

    #[derive(defmt::Format)]
    struct My {}

    let s = My {};
    let e = nb::Error::Other(s);
    defmt::info!("Error: {}", e);

This panics in RttEncoder::acquire because the defmt encoder is acquired recursively.

I can also confirm that this PR fixes the issue, at least for the case mentioned above.

To me, this looks like an issue that should be solved in defmt, as it is easy to accidentally use the defmt API in a way triggering this panic. However, I have no idea how to fix that in defmt or if it is even possible without a breaking change.

So even if this PR is only a workaround, it is one that doesn't hurt at all, so we should apply it.

[jannic]

LGTM. The issue reported by the CI pipeline is already fixed on the master branch so the PR only needs to be rebased.

[optlink]

Rebased

[BartMassey]

Thanks again for this.

[eldruin]

Sounds good to me and sorry for the delay.
Could you add an entry to the changelog about this as well?

[optlink]

Changelog entry added.

[eldruin]

Thank you!