<!--
{
  "availability" : [
    "iOS: 14.0.0 -",
    "iPadOS: 14.0.0 -",
    "macCatalyst: -",
    "macOS: 11.0.0 -",
    "tvOS: 14.0.0 -",
    "visionOS: -",
    "watchOS: 7.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "AppleArchive",
  "identifier" : "/documentation/AppleArchive/ArchiveStream/withConvertStream(writingTo:insertKeySet:removeKeySet:selectUsing:flags:threadCount:_:)",
  "metadataVersion" : "0.1.0",
  "role" : "Type Method",
  "symbol" : {
    "kind" : "Type Method",
    "modules" : [
      "Apple Archive",
      "AppleArchive"
    ],
    "preciseIdentifier" : "s:12AppleArchive0B6StreamC011withConvertC09writingTo12insertKeySet06removeiJ011selectUsing5flags11threadCount_xAC_AA0B6HeaderC05FieldiJ0CAnL18EntryMessageStatusVAL0sT0V_6System8FilePathVAL0S10FilterDataOSgtcSgAA0B5FlagsVSixACKXEtKlFZ"
  },
  "title" : "withConvertStream(writingTo:insertKeySet:removeKeySet:selectUsing:flags:threadCount:_:)"
}
-->

# withConvertStream(writingTo:insertKeySet:removeKeySet:selectUsing:flags:threadCount:_:)

Calls the given closure with a convert output archive stream.

```
static func withConvertStream<E>(writingTo stream: ArchiveStream, insertKeySet: ArchiveHeader.FieldKeySet, removeKeySet: ArchiveHeader.FieldKeySet, selectUsing filter: ArchiveHeader.EntryFilter? = nil, flags: ArchiveFlags = [], threadCount: Int = 0, _ body: (ArchiveStream) throws -> E) throws -> E
```

## Parameters

`stream`

The stream that receives the converted archive stream.

`insertKeySet`

A set of keys to fields that the operation inserts into the converted archive.

`removeKeySet`

A set of keys to fields that the operation removes from the converted archive.

`filter`

A closure that’s called for each entry that’s received by the stream.

`flags`

Flags that control the behavior of the operation.

`threadCount`

The number of worker threads that the operation uses, set to `0` for default.

`body`

A closure with the archive stream passed as a parameter.

## Return Value

The result of the closure.

## Discussion

This function opens a stream created by [`convertStream(writingTo:insertKeySet:removeKeySet:selectUsing:flags:threadCount:)`](/documentation/AppleArchive/ArchiveStream/convertStream(writingTo:insertKeySet:removeKeySet:selectUsing:flags:threadCount:)), calls the specified closure, and closes the stream.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)