jimeh/go-render
1
0
Fork 0
mirror of https://github.com/jimeh/go-render.git synced 2026-02-19 11:26:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(examples): improve Render examples

Browse Source
This commit is contained in:
Jim Myhrberg
2024-03-18 00:10:56 +00:00
parent b5c4ffa0b5
commit a1b1ef82ad
1 changed files with 72 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

102
render_example_test.go
View File

@@ -10,35 +10,21 @@ import (
"github.com/jimeh/go-render"
)
type User struct {
Name string `json:"name" yaml:"name" xml:"name"`
Age int `json:"age" yaml:"age" xml:"age"`
Roles []*Role `json:"roles" yaml:"roles" xml:"roles"`
Tags []string `json:"tags" yaml:"tags" xml:"tags"`
XMLName xml.Name `json:"-" yaml:"-" xml:"user"`
}
func (u *User) String() string {
return fmt.Sprintf(
"%s (%d): %s",
u.Name, u.Age, strings.Join(u.Tags, ", "),
)
}
type Role struct {
Name string `json:"name" yaml:"name" xml:"name"`
Icon string `json:"icon" yaml:"icon" xml:"icon"`
}
func (r *Role) WriteTo(w io.Writer) (int64, error) {
s := fmt.Sprintf("%s (%s)", r.Name, r.Icon)
n, err := w.Write([]byte(s))
return int64(n), err
}
func ExampleRender_json() {
type Role struct {
Name string `json:"name" yaml:"name" xml:"name"`
Icon string `json:"icon" yaml:"icon" xml:"icon"`
}
type User struct {
Name string `json:"name" yaml:"name" xml:"name"`
Age int `json:"age" yaml:"age" xml:"age"`
Roles []*Role `json:"roles" yaml:"roles" xml:"roles"`
Tags []string `json:"tags" yaml:"tags" xml:"tags"`
XMLName xml.Name `json:"-" yaml:"-" xml:"user"`
}
data := &User{
Name: "John Doe",
Age: 30,
@@ -81,6 +67,20 @@ func ExampleRender_json() {
}
func ExampleRender_yaml() {
type Role struct {
Name string `json:"name" yaml:"name" xml:"name"`
Icon string `json:"icon" yaml:"icon" xml:"icon"`
}
type User struct {
Name string `json:"name" yaml:"name" xml:"name"`
Age int `json:"age" yaml:"age" xml:"age"`
Roles []*Role `json:"roles" yaml:"roles" xml:"roles"`
Tags []string `json:"tags" yaml:"tags" xml:"tags"`
XMLName xml.Name `json:"-" yaml:"-" xml:"user"`
}
data := &User{
Name: "John Doe",
Age: 30,
@@ -115,6 +115,20 @@ func ExampleRender_yaml() {
}
func ExampleRender_xml() {
type Role struct {
Name string `json:"name" yaml:"name" xml:"name"`
Icon string `json:"icon" yaml:"icon" xml:"icon"`
}
type User struct {
Name string `json:"name" yaml:"name" xml:"name"`
Age int `json:"age" yaml:"age" xml:"age"`
Roles []*Role `json:"roles" yaml:"roles" xml:"roles"`
Tags []string `json:"tags" yaml:"tags" xml:"tags"`
XMLName xml.Name `json:"-" yaml:"-" xml:"user"`
}
data := &User{
Name: "John Doe",
Age: 30,
@@ -152,16 +166,44 @@ func ExampleRender_xml() {
// </user>
}
type Role struct {
Name string `json:"name" yaml:"name" xml:"name"`
Icon string `json:"icon" yaml:"icon" xml:"icon"`
}
func (r *Role) WriteTo(w io.Writer) (int64, error) {
s := fmt.Sprintf("%s (%s)", r.Name, r.Icon)
n, err := w.Write([]byte(s))
return int64(n), err
}
type User struct {
Name string `json:"name" yaml:"name" xml:"name"`
Age int `json:"age" yaml:"age" xml:"age"`
Roles []*Role `json:"roles" yaml:"roles" xml:"roles"`
Tags []string `json:"tags" yaml:"tags" xml:"tags"`
XMLName xml.Name `json:"-" yaml:"-" xml:"user"`
}
func (u *User) String() string {
return fmt.Sprintf(
"%s (%d): %s",
u.Name, u.Age, strings.Join(u.Tags, ", "),
)
}
func ExampleRender_textViaStringer() {
// The User struct has a String method which returns a string representation
// of a user:
//
// func (u *User) String() string {
// func (u *User) String() string {
// return fmt.Sprintf(
// "%s (%d): %s",
// u.Name, u.Age, strings.Join(u.Tags, ", "),
// )
// }
// }
data := &User{
Name: "John Doe",