init(_:children:displayStyle:ancestorRepresentation:)

Declaration

init<Subject, C>(_ subject: Subject, children: C, displayStyle: Mirror.DisplayStyle? = nil, ancestorRepresentation: Mirror.AncestorRepresentation = .generated) where C : Collection, C.Element == (label: String?, value: Any)

Parameters

• subject:

  The instance to represent in the new mirror.

• children:

  The structure to use for the mirror. The collection traversal modeled by children is captured so that the resulting mirror’s children may be upgraded to a bidirectional or random access collection later. See the children property for details.

• displayStyle:

  The preferred display style for the mirror when presented in the debugger or in a playground. The default is nil.

• ancestorRepresentation:

  The means of generating the subject’s ancestor representation. ancestorRepresentation is ignored if subject is not a class instance. The default is .generated.

Discussion

You use this initializer from within your type’s customMirror implementation to create a customized mirror.

If subject is a class instance, ancestorRepresentation determines whether ancestor classes will be represented and whether their customMirror implementations will be used. By default, the customMirror implementation of any ancestors is ignored. To prevent bypassing customized ancestors, pass .customized({ super.customMirror }) as the ancestorRepresentation parameter when implementing your type’s customMirror property.