ent/entc/gen/template/builder/setter.tmpl

{{/*
Copyright 2019-present Facebook Inc. All rights reserved.
This source code is licensed under the Apache 2.0 license found
in the LICENSE file in the root directory of this source tree.
*/}}

{{/* gotype: entgo.io/ent/entc/gen.Type */}}

{{ define "setter" }}
{{ $builder := pascal $.Scope.Builder }}
{{ $fields := $.Fields }}
{{ $updater := false }}
{{ $creator := true }}
{{- if or (hasSuffix $builder "Update") (hasSuffix $builder "UpdateOne") }}
	{{ $updater = true }}
	{{ $creator = false }}
	{{ $fields = $.MutableFields }}
{{- else if $.HasCompositeID }}
{{- else if $.ID.UserDefined }}
	{{ $fields = append $fields $.ID }}
{{- end }}

{{ range $f := $fields }}
	{{ $func := print "Set" $f.StructField }}
	// {{ $func }} sets the "{{ $f.Name }}" field.
	func (m *{{ $builder }}) {{ $func }}(v {{ $f.Type }}) *{{ $builder }} {
		{{- /* setting numeric type override previous calls to Add. */}}
		{{- if and $updater $f.SupportsMutationAdd }}
			m.mutation.{{ $f.MutationReset }}()
		{{- end }}
		m.mutation.{{ $f.MutationSet }}(v)
		return m
	}

	{{/* Avoid generating nillable setters for nillable types. */}}
	{{ $nillableC := and $creator (or $f.Optional $f.Default) }}
	{{ $nillableU := and $updater (not $f.UpdateDefault) }}
	{{ $nillableFunc := print "SetNillable" $f.StructField }}
	{{ $skipNillable := false }}{{ range $fields }}{{ if and (ne .Name $f.Name) (eq .MutationSet $nillableFunc) }}{{ $skipNillable = true }}{{ break }}{{ end }}{{ end }}
	{{ if and (not $f.Type.Nillable) (not $skipNillable) (or $nillableC $nillableU) }}
		// {{ $nillableFunc }} sets the "{{ $f.Name }}" field if the given value is not nil.
		func (m *{{ $builder }}) {{ $nillableFunc }}(v *{{ $f.Type }}) *{{ $builder }} {
			if v != nil {
				m.{{ $func }}(*v)
			}
			return m
		}
	{{ end }}

	{{ if and $updater $f.SupportsMutationAdd }}
		// {{ $f.MutationAdd }} adds value to the "{{ $f.Name }}" field.
		func (m *{{ $builder }}) {{ $f.MutationAdd }}(v {{ $f.SignedType }}) *{{ $builder }} {
			m.mutation.{{ $f.MutationAdd }}(v)
			return m
		}
	{{ end }}

	{{ if and $updater $f.SupportsMutationAppend }}
		// {{ $f.MutationAppend }} appends value to the "{{ $f.Name }}" field.
		func (m *{{ $builder }}) {{ $f.MutationAppend }}(v {{ $f.Type }}) *{{ $builder }} {
			m.mutation.{{ $f.MutationAppend }}(v)
			return m
		}
	{{ end }}

	{{ if and $f.Optional $updater }}
		{{ $func := print "Clear" $f.StructField }}
		// {{ $func }} clears the value of the "{{ $f.Name }}" field.
		func (m *{{ $builder }}) {{ $func }}() *{{ $builder }} {
			m.mutation.{{ $func }}()
			return m
		}
	{{ end }}
{{ end }}

{{ range $e := $.EdgesWithID }}
	{{ if and $updater $e.Immutable }}
		{{/* Skip to the next one as immutable edges cannot be updated. */}}
		{{continue}}
	{{ end }}
	{{ $op := "add" }}{{ $idsFunc := $e.MutationAdd }}{{ if $e.Unique }}{{ $op = "set" }}{{ $idsFunc = $e.MutationSet }}{{ end }}
	{{/* Check if this setter was already defined by the field-setters (e.g. edge-field with the same name). */}}
	{{ $withSetter := not $e.HasFieldSetter }}
	{{ if $withSetter }}
		// {{ $idsFunc }} {{ $op }}s the "{{ $e.Name }}" edge to the {{ $e.Type.Name }} entity by ID{{ if not $e.Unique }}s{{ end }}.
		func (m *{{ $builder }}) {{ $idsFunc }}({{ if $e.Unique }}id{{ else }}ids ...{{ end }} {{ $e.Type.ID.Type }}) *{{ $builder }} {
			m.mutation.{{ $idsFunc }}({{ if $e.Unique }}id{{ else }}ids ...{{ end }})
			return m
		}
	{{ end }}
	{{ if and $e.Unique $e.Optional $withSetter }}
		{{ $nillableIDsFunc := print "SetNillable" $e.StructField "ID" }}
		// {{ $nillableIDsFunc }} sets the "{{ $e.Name }}" edge to the {{ $e.Type.Name }} entity by ID if the given value is not nil.
		func (m *{{ $builder }}) {{ $nillableIDsFunc }}(id *{{ $e.Type.ID.Type }}) *{{ $builder }} {
			if id != nil {
				m = m.{{ $idsFunc }}(*id)
			}
			return m
		}
	{{ end }}
	{{ $func := print (pascal $op) $e.StructField }}
	// {{ $func }} {{ $op }}s the "{{ $e.Name }}" edge{{if not $e.Unique}}s{{ end }} to the {{ $e.Type.Name }} entity.
	func (m *{{ $builder }}) {{ $func }}(v {{ if not $e.Unique }}...{{ end }}*{{ $e.Type.Name}}) *{{ $builder }} {
		{{ if $e.Unique -}}
			return m.{{ $idsFunc }}(v.ID)
		{{- else -}}
			ids := make([]{{ $e.Type.ID.Type }}, len(v))
			for i := range v {
				ids[i] = v[i].ID
			}
			return m.{{ $idsFunc }}(ids...)
		{{- end }}
	}
{{ end }}

// Mutation returns the {{ $.MutationName }} object of the builder.
func (m *{{ $builder }}) Mutation() *{{ $.MutationName }} {
	return m.mutation
}

{{ end }}