cupertino-docs/docs/dispatch/documentation_dispatch_dispatch_data_create_map.json
Mihaela Mihaljevic 1eae0594fc data: refresh docs/ + add packages/ from .cupertino-dev
Bulk update of the public corpus from /Users/mmj/.cupertino-dev/, the
local source that built v1.0.0 / v1.0.1 release database bundles.

- docs/: 1,739 new pages, 403,381 modified (schema upgrade to the
  structured-page format used by v1.0+: overview, rawMarkdown,
  sections[].items[]). Total 404,568 page JSONs (2.4 GB).
- packages/: 1,587 packages (1.5 GB), previously empty in this repo.
  Includes per-package source archives and READMEs for the curated
  Swift package set. Some packages (notably swiftlang/swift-foundation-icu)
  ship 50-100 MB ICU lookup tables — under GitHub's 100 MB limit.

No deletions: existing files not in .cupertino-dev are preserved
(e.g. swift-org/ has 81 historical pages this update doesn't touch).
2026-05-09 12:58:32 +02:00

134 lines
7.3 KiB
JSON
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"abstract" : "Returns a new dispatch data object containing a contiguous representation of the specified objects memory.",
"availability" : [
{
"beta" : false,
"deprecated" : false,
"introducedAt" : "5.0",
"name" : "iOS",
"unavailable" : false
},
{
"beta" : false,
"deprecated" : false,
"introducedAt" : "5.0",
"name" : "iPadOS",
"unavailable" : false
},
{
"beta" : false,
"deprecated" : false,
"introducedAt" : "13.1",
"name" : "Mac Catalyst",
"unavailable" : false
},
{
"beta" : false,
"deprecated" : false,
"introducedAt" : "10.7",
"name" : "macOS",
"unavailable" : false
},
{
"beta" : false,
"deprecated" : false,
"name" : "tvOS",
"unavailable" : false
},
{
"beta" : false,
"deprecated" : false,
"introducedAt" : "1.0",
"name" : "visionOS",
"unavailable" : false
},
{
"beta" : false,
"deprecated" : false,
"introducedAt" : "2.0",
"name" : "watchOS",
"unavailable" : false
}
],
"codeExamples" : [
],
"contentHash" : "7ea2e76ddc727d0c69c0714b72e7c488a5501f43cd09567404fac4346b9938db",
"crawlDepth" : 4,
"crawledAt" : "2026-05-03T05:36:25Z",
"declaration" : {
"code" : "extern dispatch_data_tdispatch_data_create_map(dispatch_data_t data, const void **buffer_ptr, size_t *size_ptr);",
"language" : "swift"
},
"id" : "B8A46136-8F17-27A3-DA21-3D2DA95552E5",
"kind" : "function",
"language" : "occ",
"module" : "Dispatch",
"overview" : "## Return Value\n\nA new dispatch data object containing the contiguous version of the memory managed by the object in the `data` parameter.\n\n## Discussion\n\nIf you specify non-`NULL` values for `buffer_ptr` or `size_ptr`, the values returned in those variables are valid only until you release the newly created dispatch data object. You can use these values as a quick way to access the data of the new data object.",
"platforms" : [
"iOS",
"iPadOS",
"Mac Catalyst",
"macOS",
"tvOS",
"visionOS",
"watchOS"
],
"rawMarkdown" : "---\nsource: https:\/\/developer.apple.com\/documentation\/dispatch\/dispatch_data_create_map\ncrawled: 2026-05-03T05:36:25Z\n---\n\n# dispatch_data_create_map\n\n**Function**\n\nReturns a new dispatch data object containing a contiguous representation of the specified objects memory.\n\n## Declaration\n\n```swift\nextern dispatch_data_tdispatch_data_create_map(dispatch_data_t data, const void **buffer_ptr, size_t *size_ptr);\n```\n\n## Parameters\n\n- **data**: A dispatch data object containing the memory to map. If the object contains multiple noncontiguous memory regions, those regions are copied to a single, contiguous memory region for the new object.\n- **buffer_ptr**: On input, a pointer to a variable in which to store the pointer to the memory region for the newly created dispatch data object. You may specify `NULL` for this parameter if you do not need the information.\n- **size_ptr**: On input, a pointer to a variable in which to store the size of the contiguous memory region in the newly created dispatch data object. You may specify `NULL` for this parameter if you do not need the information.\n\n## Return Value\n\nA new dispatch data object containing the contiguous version of the memory managed by the object in the `data` parameter.\n\n## Discussion\n\nIf you specify non-`NULL` values for `buffer_ptr` or `size_ptr`, the values returned in those variables are valid only until you release the newly created dispatch data object. You can use these values as a quick way to access the data of the new data object.\n\n## Creating a Dispatch Data Object\n\n- **dispatch_data_create**: Creates a new dispatch data object with the specified memory buffer.\n- **dispatch_data_create_concat**: Returns a new dispatch data object consisting of the concatenated data from two other data objects.\n- **dispatch_data_create_subrange**: Returns a new dispatch data object whose contents consist of a portion of another objects memory region.\n- **dispatch_data_copy_region**: Returns a data object containing a portion of the data in another data object.\n- **dispatch_data_empty**: A dispatch data object representing a zero-length memory region.\n- **dispatch_data_t**: An immutable object representing a contiguous or sparse region of memory.\n- **OS_dispatch_data**\n- **DISPATCH_DATA_DESTRUCTOR_DEFAULT**: The default data destructor for dispatch objects.\n- **DISPATCH_DATA_DESTRUCTOR_FREE**: The destructor for dispatch data objects whose memory buffer was created using the malloc family of allocation routines.\n\n",
"sections" : [
{
"content" : "",
"items" : [
{
"description" : "Creates a new dispatch data object with the specified memory buffer.",
"name" : "dispatch_data_create",
"url" : "https:\/\/developer.apple.com\/documentation\/Dispatch\/dispatch_data_create"
},
{
"description" : "Returns a new dispatch data object consisting of the concatenated data from two other data objects.",
"name" : "dispatch_data_create_concat",
"url" : "https:\/\/developer.apple.com\/documentation\/Dispatch\/dispatch_data_create_concat"
},
{
"description" : "Returns a new dispatch data object whose contents consist of a portion of another objects memory region.",
"name" : "dispatch_data_create_subrange",
"url" : "https:\/\/developer.apple.com\/documentation\/Dispatch\/dispatch_data_create_subrange"
},
{
"description" : "Returns a data object containing a portion of the data in another data object.",
"name" : "dispatch_data_copy_region",
"url" : "https:\/\/developer.apple.com\/documentation\/Dispatch\/dispatch_data_copy_region"
},
{
"description" : "A dispatch data object representing a zero-length memory region.",
"name" : "dispatch_data_empty",
"url" : "https:\/\/developer.apple.com\/documentation\/Dispatch\/dispatch_data_empty"
},
{
"description" : "An immutable object representing a contiguous or sparse region of memory.",
"name" : "dispatch_data_t",
"url" : "https:\/\/developer.apple.com\/documentation\/Dispatch\/dispatch_data_t"
},
{
"description" : "",
"name" : "OS_dispatch_data",
"url" : "https:\/\/developer.apple.com\/documentation\/Dispatch\/OS_dispatch_data"
},
{
"description" : "The default data destructor for dispatch objects.",
"name" : "DISPATCH_DATA_DESTRUCTOR_DEFAULT",
"url" : "https:\/\/developer.apple.com\/documentation\/Dispatch\/DISPATCH_DATA_DESTRUCTOR_DEFAULT"
},
{
"description" : "The destructor for dispatch data objects whose memory buffer was created using the malloc family of allocation routines.",
"name" : "DISPATCH_DATA_DESTRUCTOR_FREE",
"url" : "https:\/\/developer.apple.com\/documentation\/Dispatch\/DISPATCH_DATA_DESTRUCTOR_FREE"
}
],
"title" : "Creating a Dispatch Data Object"
}
],
"source" : "appleJSON",
"title" : "dispatch_data_create_map",
"url" : "https:\/\/developer.apple.com\/documentation\/dispatch\/dispatch_data_create_map"
}