Don't emit `fmt::Error`

オープン
#1,419 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
30/100
issue の種類
リファクタリング
明瞭さ
おおむね明確
活発さ
活発
技術スタック
rust

調査の方向性

The issue concerns the Display impl for Device and its use of fmt::Error when self.description() fails, plus a proposal to add a .name() method to DeviceTrait. Read the Device and DeviceTrait definitions and the host backends that implement them before anything else. Done would mean the agreed design is settled, the fmt::Error mapping is removed from the hosts, and the affected tests pass. Because the API direction is still open, confirm it with maintainers before editing.

索引モデルが issue の本文から書いたものです。

説明

API design correctness

From fmt::Error's doc comment:

This type does not support transmission of an error other than that an error occurred. This is because, despite the existence of this error, string formatting is considered an infallible operation. fmt() implementors should not return this Error unless they received it from their Formatter. The only time your code should create a new instance of this error is when implementing fmt::Write, in order to cancel the formatting operation when writing to the underlying stream fails.

We currently have this in almost every host:

impl fmt::Display for Device {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let desc = self.description().map_err(|_| fmt::Error)?;
        f.write_str(desc.name())
    }
}

I find Device implementing Display strange anyway. How about we add a .name() function to DeviceTrait instead?

主要言語
Rust
スター
4k
フォーク
554
平均マージ
3日 3時間
マージ済み PR(30日)
4

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

RustAudio/cpal のほかの issue

RustAudio/cpal の issue をすべて見る

似ている issue

Rust の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。