text.go — gin Source File

Architecture documentation for text.go, a go file in the gin codebase. 1 imports, 0 dependents.

File go ResponseRendering TemplateEngine 1 imports 1 functions 1 classes

Entity Profile

ResponseRendering→ TemplateEngine→ text.go — gin Source File

Dependency Diagram

graph LR
  0d7062ba_5ddd_c2ed_4240_42b2dab1e9c2["text.go"]
  e8c9ceab_299a_1e0e_919f_ddb404deb199["fmt"]
  0d7062ba_5ddd_c2ed_4240_42b2dab1e9c2 --> e8c9ceab_299a_1e0e_919f_ddb404deb199
  style 0d7062ba_5ddd_c2ed_4240_42b2dab1e9c2 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

// Copyright 2014 Manu Martinez-Almeida. All rights reserved.
// Use of this source code is governed by a MIT style
// license that can be found in the LICENSE file.

package render

import (
	"fmt"
	"net/http"

	"github.com/gin-gonic/gin/internal/bytesconv"
)

// String contains the given interface object slice and its format.
type String struct {
	Format string
	Data   []any
}

var plainContentType = []string{"text/plain; charset=utf-8"}

// Render (String) writes data with custom ContentType.
func (r String) Render(w http.ResponseWriter) error {
	return WriteString(w, r.Format, r.Data)
}

// WriteContentType (String) writes Plain ContentType.
func (r String) WriteContentType(w http.ResponseWriter) {
	writeContentType(w, plainContentType)
}

// WriteString writes data according to its format and write custom ContentType.
func WriteString(w http.ResponseWriter, format string, data []any) (err error) {
	writeContentType(w, plainContentType)
	if len(data) > 0 {
		_, err = fmt.Fprintf(w, format, data...)
		return
	}
	_, err = w.Write(bytesconv.StringToBytes(format))
	return
}