github.com/GoogleContainerTools/kpt@v1.0.0-beta.50.0.20240520170205-c25345ffcbee/pkg/debug/formatter.go (about)

     1  // Copyright 2022 The kpt 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  //      http://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 debug
    16  
    17  import (
    18  	"encoding/json"
    19  	"fmt"
    20  )
    21  
    22  // DeferredJSON is a helper that delays JSON formatting until/unless it is needed.
    23  type DeferredJSON struct {
    24  	O interface{}
    25  }
    26  
    27  // String is the method that is called to format the object.
    28  func (d DeferredJSON) String() string {
    29  	b, err := json.Marshal(d.O)
    30  	if err != nil {
    31  		return fmt.Sprintf("<error: %v>", err)
    32  	}
    33  	return string(b)
    34  }
    35  
    36  // JSON is a helper that prints the object in JSON format.
    37  // We use lazy-evaluation to avoid calling json.Marshal unless it is actually needed.
    38  func JSON(o interface{}) DeferredJSON {
    39  	return DeferredJSON{o}
    40  }