query.go 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. package json
  2. import (
  3. "github.com/goccy/go-json/internal/encoder"
  4. )
  5. type (
  6. // FieldQuery you can dynamically filter the fields in the structure by creating a FieldQuery,
  7. // adding it to context.Context using SetFieldQueryToContext and then passing it to MarshalContext.
  8. // This is a type-safe operation, so it is faster than filtering using map[string]interface{}.
  9. FieldQuery = encoder.FieldQuery
  10. FieldQueryString = encoder.FieldQueryString
  11. )
  12. var (
  13. // FieldQueryFromContext get current FieldQuery from context.Context.
  14. FieldQueryFromContext = encoder.FieldQueryFromContext
  15. // SetFieldQueryToContext set current FieldQuery to context.Context.
  16. SetFieldQueryToContext = encoder.SetFieldQueryToContext
  17. )
  18. // BuildFieldQuery builds FieldQuery by fieldName or sub field query.
  19. // First, specify the field name that you want to keep in structure type.
  20. // If the field you want to keep is a structure type, by creating a sub field query using BuildSubFieldQuery,
  21. // you can select the fields you want to keep in the structure.
  22. // This description can be written recursively.
  23. func BuildFieldQuery(fields ...FieldQueryString) (*FieldQuery, error) {
  24. query, err := Marshal(fields)
  25. if err != nil {
  26. return nil, err
  27. }
  28. return FieldQueryString(query).Build()
  29. }
  30. // BuildSubFieldQuery builds sub field query.
  31. func BuildSubFieldQuery(name string) *SubFieldQuery {
  32. return &SubFieldQuery{name: name}
  33. }
  34. type SubFieldQuery struct {
  35. name string
  36. }
  37. func (q *SubFieldQuery) Fields(fields ...FieldQueryString) FieldQueryString {
  38. query, _ := Marshal(map[string][]FieldQueryString{q.name: fields})
  39. return FieldQueryString(query)
  40. }