pingcap / pingcap/tiflash

Formatting User-Defined Types

Open
#5,880 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted type/enhancement
Dominant language
C++
Stars
1k
Forks
423
Avg merge
1d 15h
Merged PRs (30d)
24

Description

Enhancement

In TiFlash we use fmt library to serialize a bunch of objects, but we don't support formatting User-defined types.
We can implement format method for our user-defined types by specializing the formatter struct template.
Can ref to https://fmt.dev/latest/api.html?highlight=fmt%20formatter#formatting-user-defined-types.

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 with the fmt.dev documentation on formatting user-defined types, then inspect TiFlash's existing fmt-based serialization sites. Identify which user-defined types are in scope and how their current formatting is covered; done means the agreed types support fmt formatter customization with corresponding coverage.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.