1// Copyright 2025 CUE Authors
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// https://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15// Package format provides functionality for pretty-printing CUE values.
16// These types need to be in a separate package to avoid import cycles.
17package format
18
19// Printer is the interface used to print CUE values. The only implementation so
20// far is the one in internal/core/debug. Note that most packages cannot
21// directly import the debug package.
22type Printer interface {
23 // ReplaceArg is a function that may be called to replace arguments to
24 // errors. This is mostly used for cycle detection.
25 ReplaceArg(x any) (r any, wasReplaced bool)
26}