Method makeResourceObject

marshal.go:322–486

(v any, vt reflect.Type, m *Marshaler)

}

func (d *document) makeResourceObject(v any, vt reflect.Type, m *Marshaler) (*resourceObject, error) {
	// the given "v" here is a single resource object

	// first, it must be a struct since we'll be parsing the jsonapi struct tags
	if derefType(vt).Kind() != reflect.Struct {
		return nil, &TypeError{Actual: vt.String(), Expected: []string{"struct"}}
	}

	ro := &resourceObject{
		Attributes:    make(map[string]any, 0),
		Relationships: make(map[string]*document, 0),
	}

	// get fields from embedded structs
	fields := getFlattenedFields(v)

	var foundPrimary bool
	for _, field := range fields {
		// for each field in the struct we'll parse the jsonapi struct tag
		// this will determine where it goes in the resource object (e.g. id,type,attributes,...)

		f := field.v
		ft := field.f

		tag, err := parseJSONAPITag(ft)
		if err != nil {
			return nil, err
		}
		if tag == nil {
			// this field is not tagged w/ jsonapi and will be ignored
			continue
		}

		switch tag.directive {
		case primary:
			ro.Type = tag.resourceType
			if vmt, ok := v.(MarshalType); ok {
				ro.Type = vmt.MarshalType()
			}
			if !isValidMemberName(ro.Type, m.memberNameValidationMode) {
				// type names count as member names
				return nil, &MemberNameValidationError{ro.Type}
			}

			// to marshal the id we follow these rules
			//     1. Use MarshalIdentifier if it is implemented
			//     2. Use the value directly if it is a string
			//     3. Use fmt.Stringer if it is implemented
			//     4. Use encoding.TextMarshaler if it is implemented
			//     5. Fail

			if vm, ok := v.(MarshalIdentifier); ok {
				ro.ID = vm.MarshalID()
				foundPrimary = true
				continue
			}

			fv := f.Interface()