FunctionSwift

dump(_:to:name:indent:maxDepth:maxItems:)

Dumps the given object’s contents using its mirror to the specified output stream.

@discardableResult func dump<T, TargetStream>(_ value: T, to target: inout TargetStream, name: String? = nil, indent: Int = 0, maxDepth: Int = .max, maxItems: Int = .max) -> T where TargetStream : TextOutputStream

Parameters

value

The value to output to the target stream.

target

The stream to use for writing the contents of value.

name

A label to use when writing the contents of value. When nil is passed, the label is omitted. The default is nil.

indent

The number of spaces to use as an indent for each line of the output. The default is 0.

maxdepth

The maximum depth to descend when writing the contents of a value that has nested components. The default is Int.max.

maxitems

The maximum number of elements for which to write the full contents. The default is Int.max.

Returns

The instance passed as value.