hook

Documentation

Index

• func FixedError(err error) ent.Hook
• func If(hk ent.Hook, cond Condition) ent.Hook
• func On(hk ent.Hook, op ent.Op) ent.Hook
• func Reject(op ent.Op) ent.Hook
• func Unless(hk ent.Hook, op ent.Op) ent.Hook
• type AdministratorFunc
  • func (f AdministratorFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)
• type Chain
  • func NewChain(hooks ...ent.Hook) Chain
  • func (c Chain) Append(hooks ...ent.Hook) Chain
  • func (c Chain) Extend(chain Chain) Chain
  • func (c Chain) Hook() ent.Hook
• type Condition
  • func And(first, second Condition, rest ...Condition) Condition
  • func HasAddedFields(field string, fields ...string) Condition
  • func HasClearedFields(field string, fields ...string) Condition
  • func HasFields(field string, fields ...string) Condition
  • func HasOp(op ent.Op) Condition
  • func Not(cond Condition) Condition
  • func Or(first, second Condition, rest ...Condition) Condition
• type DeletedVlanLogFunc
  • func (f DeletedVlanLogFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)
• type DeviceFunc
  • func (f DeviceFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)
• type DevicePlatformFunc
  • func (f DevicePlatformFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)
• type DeviceTypeFunc
  • func (f DeviceTypeFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)
• type IPAddressFunc
  • func (f IPAddressFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)
• type IPStaticRoutingTableFunc
  • func (f IPStaticRoutingTableFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)
• type NetInterfaceFunc
  • func (f NetInterfaceFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)
• type NetInterfaceLayerFunc
  • func (f NetInterfaceLayerFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)
• type NetInterfaceModeFunc
  • func (f NetInterfaceModeFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)
• type NetTopologyDeviceMapFunc
  • func (f NetTopologyDeviceMapFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)
• type NetTopologyFunc
  • func (f NetTopologyFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)
• type PortChannelInterfaceFunc
  • func (f PortChannelInterfaceFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)
• type VlanFunc
  • func (f VlanFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)

Functions

func FixedError

func FixedError(err error) ent.Hook

FixedError is a hook returning a fixed error.

func If

func If(hk ent.Hook, cond Condition) ent.Hook

If executes the given hook under condition.

hook.If(ComputeAverage, And(HasFields(...), HasAddedFields(...)))

func On

func On(hk ent.Hook, op ent.Op) ent.Hook

On executes the given hook only for the given operation.

hook.On(Log, ent.Delete|ent.Create)

func Reject

func Reject(op ent.Op) ent.Hook

Reject returns a hook that rejects all operations that match op.

func (T) Hooks() []ent.Hook {
	return []ent.Hook{
		Reject(ent.Delete|ent.Update),
	}
}

func Unless

func Unless(hk ent.Hook, op ent.Op) ent.Hook

Unless skips the given hook only for the given operation.

hook.Unless(Log, ent.Update|ent.UpdateOne)

Types

type AdministratorFunc

type AdministratorFunc func(context.Context, *ent.AdministratorMutation) (ent.Value, error)

The AdministratorFunc type is an adapter to allow the use of ordinary function as Administrator mutator.

func (AdministratorFunc) Mutate

func (f AdministratorFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)

Mutate calls f(ctx, m).

type Chain

type Chain struct {
	// contains filtered or unexported fields
}

Chain acts as a list of hooks and is effectively immutable. Once created, it will always hold the same set of hooks in the same order.

func NewChain

func NewChain(hooks ...ent.Hook) Chain

NewChain creates a new chain of hooks.

func (Chain) Append

func (c Chain) Append(hooks ...ent.Hook) Chain

Append extends a chain, adding the specified hook as the last ones in the mutation flow.

func (Chain) Extend

func (c Chain) Extend(chain Chain) Chain

Extend extends a chain, adding the specified chain as the last ones in the mutation flow.

func (Chain) Hook

func (c Chain) Hook() ent.Hook

Hook chains the list of hooks and returns the final hook.

type Condition

type Condition func(context.Context, ent.Mutation) bool

Condition is a hook condition function.

func And

func And(first, second Condition, rest ...Condition) Condition

And groups conditions with the AND operator.

func HasAddedFields

func HasAddedFields(field string, fields ...string) Condition

HasAddedFields is a condition validating `.AddedField` on fields.

func HasClearedFields

func HasClearedFields(field string, fields ...string) Condition

HasClearedFields is a condition validating `.FieldCleared` on fields.

func HasFields

func HasFields(field string, fields ...string) Condition

HasFields is a condition validating `.Field` on fields.

func HasOp

func HasOp(op ent.Op) Condition

HasOp is a condition testing mutation operation.

func Not

func Not(cond Condition) Condition

Not negates a given condition.

func Or

func Or(first, second Condition, rest ...Condition) Condition

Or groups conditions with the OR operator.

type DeletedVlanLogFunc

type DeletedVlanLogFunc func(context.Context, *ent.DeletedVlanLogMutation) (ent.Value, error)

The DeletedVlanLogFunc type is an adapter to allow the use of ordinary function as DeletedVlanLog mutator.

func (DeletedVlanLogFunc) Mutate

func (f DeletedVlanLogFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)

Mutate calls f(ctx, m).

type DeviceFunc

type DeviceFunc func(context.Context, *ent.DeviceMutation) (ent.Value, error)

The DeviceFunc type is an adapter to allow the use of ordinary function as Device mutator.

func (DeviceFunc) Mutate

func (f DeviceFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)

Mutate calls f(ctx, m).

type DevicePlatformFunc

type DevicePlatformFunc func(context.Context, *ent.DevicePlatformMutation) (ent.Value, error)

The DevicePlatformFunc type is an adapter to allow the use of ordinary function as DevicePlatform mutator.

func (DevicePlatformFunc) Mutate

func (f DevicePlatformFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)

Mutate calls f(ctx, m).

type DeviceTypeFunc

type DeviceTypeFunc func(context.Context, *ent.DeviceTypeMutation) (ent.Value, error)

The DeviceTypeFunc type is an adapter to allow the use of ordinary function as DeviceType mutator.

func (DeviceTypeFunc) Mutate

func (f DeviceTypeFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)

Mutate calls f(ctx, m).

type IPAddressFunc

type IPAddressFunc func(context.Context, *ent.IPAddressMutation) (ent.Value, error)

The IPAddressFunc type is an adapter to allow the use of ordinary function as IPAddress mutator.

func (IPAddressFunc) Mutate

func (f IPAddressFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)

Mutate calls f(ctx, m).

type IPStaticRoutingTableFunc

type IPStaticRoutingTableFunc func(context.Context, *ent.IPStaticRoutingTableMutation) (ent.Value, error)

The IPStaticRoutingTableFunc type is an adapter to allow the use of ordinary function as IPStaticRoutingTable mutator.

func (IPStaticRoutingTableFunc) Mutate

func (f IPStaticRoutingTableFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)

Mutate calls f(ctx, m).

type NetInterfaceFunc

type NetInterfaceFunc func(context.Context, *ent.NetInterfaceMutation) (ent.Value, error)

The NetInterfaceFunc type is an adapter to allow the use of ordinary function as NetInterface mutator.

func (NetInterfaceFunc) Mutate

func (f NetInterfaceFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)

Mutate calls f(ctx, m).

type NetInterfaceLayerFunc

type NetInterfaceLayerFunc func(context.Context, *ent.NetInterfaceLayerMutation) (ent.Value, error)

The NetInterfaceLayerFunc type is an adapter to allow the use of ordinary function as NetInterfaceLayer mutator.

func (NetInterfaceLayerFunc) Mutate

func (f NetInterfaceLayerFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)

Mutate calls f(ctx, m).

type NetInterfaceModeFunc

type NetInterfaceModeFunc func(context.Context, *ent.NetInterfaceModeMutation) (ent.Value, error)

The NetInterfaceModeFunc type is an adapter to allow the use of ordinary function as NetInterfaceMode mutator.

func (NetInterfaceModeFunc) Mutate

func (f NetInterfaceModeFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)

Mutate calls f(ctx, m).

type NetTopologyDeviceMapFunc

type NetTopologyDeviceMapFunc func(context.Context, *ent.NetTopologyDeviceMapMutation) (ent.Value, error)

The NetTopologyDeviceMapFunc type is an adapter to allow the use of ordinary function as NetTopologyDeviceMap mutator.

func (NetTopologyDeviceMapFunc) Mutate

func (f NetTopologyDeviceMapFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)

Mutate calls f(ctx, m).

type NetTopologyFunc

type NetTopologyFunc func(context.Context, *ent.NetTopologyMutation) (ent.Value, error)

The NetTopologyFunc type is an adapter to allow the use of ordinary function as NetTopology mutator.

func (NetTopologyFunc) Mutate

func (f NetTopologyFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)

Mutate calls f(ctx, m).

type PortChannelInterfaceFunc

type PortChannelInterfaceFunc func(context.Context, *ent.PortChannelInterfaceMutation) (ent.Value, error)

The PortChannelInterfaceFunc type is an adapter to allow the use of ordinary function as PortChannelInterface mutator.

func (PortChannelInterfaceFunc) Mutate

func (f PortChannelInterfaceFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)

Mutate calls f(ctx, m).

type VlanFunc

type VlanFunc func(context.Context, *ent.VlanMutation) (ent.Value, error)

The VlanFunc type is an adapter to allow the use of ordinary function as Vlan mutator.

func (VlanFunc) Mutate

func (f VlanFunc) Mutate(ctx context.Context, m ent.Mutation) (ent.Value, error)

Mutate calls f(ctx, m).