rust-lang / rust-lang/libs-team

impl fmt::Write for BufWriter

Open
#462 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

api-change-proposal
Dominant language
Rust
Stars
178
Forks
28
Avg merge
15m
Merged PRs (30d)
1

Description

Proposal

Problem statement

If you have an implementor of io::Write and a function that accepts an argument of type fmt::Write, it is difficult to bridge the gap.

Currently, the only way to do it is going through a formatting trait like fmt::Debug, or via an intermediate String.

Motivating examples or use cases

A generic numeric type that has existing blanket implementations of fmt::Debug and fmt::Display, but wishes to provide an additional formatting option only when certain additional generic constraints are met.

Solution sketch

impl fmt::Write for io::BufWriter { ... }

Alternatives

  • move the write_fmt method into a common supertrait.
  • a seperate dedicated wrapper type that takes an implementor of io::Write and implements fmt::Write. This wrapper struct could potentially flush the internal writer on drop.
  • an as_fmt_writer method on io::Writer
  • add some other way to construct fmt::Formatter, possibly involving passing a closure.

Downsides

  • may cause trait method resolution problems
  • does not solve the problem for no_std users
  • flushing must be done by the consumer

What happens now?

This issue contains an API change proposal (or ACP) and is part of the libs-api team feature lifecycle. Once this issue is filed, the libs-api team will review open proposals as capability becomes available. Current response times do not have a clear estimate, but may be up to several months.

Possible responses

The libs team may respond in various different ways. First, the team will consider the problem (this doesn't require any concrete solution or alternatives to have been proposed):

  • We think this problem seems worth solving, and the standard library might be the right place to solve it.
  • We think that this probably doesn't belong in the standard library.

Second, if there's a concrete solution:

  • We think this specific solution looks roughly right, approved, you or someone else should implement this. (Further review will still happen on the subsequent implementation PR.)
  • We're not sure this is the right solution, and the alternatives or other materials don't give us enough information to be sure about that. Here are some questions we have that aren't answered, or rough ideas about alternatives we'd want to see discussed.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the proposal, its alternatives, and the linked feature lifecycle guidance. There are no files, tests, or implementation entry points named in the issue. This is an API design proposal, so done would require a libs-api decision on the problem and an acceptable solution before implementation can begin.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.