/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSSerialization.html is in gnustep-base-doc 1.24.7-1build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>NSSerialization documentation</title>
</head>
<body>
<font face="serif">
<a href="Base.html">Up</a>
<br />
<h1><a name="title$NSSerialization">NSSerialization documentation</a></h1>
<h3>Authors</h3>
<dl>
<dt>Generated by root</dt>
<dd>
</dd>
</dl>
<div>
<hr width="50%" align="left" />
<h3>Contents -</h3>
<ol>
<li>
<a href="#001000000000">Software documentation for the NSDeserializer class</a>
</li>
<li>
<a href="#002000000000">Software documentation for the NSSerializer class</a>
</li>
<li>
<a href="#003000000000">Software documentation for the NSDeserializer(GNUstep)
category</a>
</li>
<li>
<a href="#004000000000">Software documentation for the NSSerializer(GNUstep)
category</a>
</li>
<li>
<a href="#005000000000">Software documentation for the
NSObjCTypeSerializationCallBack
protocol</a>
</li>
</ol>
<hr width="50%" align="left" />
</div>
<h1><a name="001000000000">
Software documentation for the NSDeserializer class
</a></h1>
<h2><a name="class$NSDeserializer">NSDeserializer</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSSerialization.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>
This class is deprecated in favor of
<a rel="gsdoc" href="NSPropertyList.html#class$NSPropertyListSerialization">NSPropertyListSerialization</a>
.</em> It provides a means of recovering a property list (NSArray or NSDictionary plus limited contents) from a byte-array (actually string) representation.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSSerialization.html#method$NSDeserializer(GNUstep)+uniquing$">+uniquing:</a></li>
<li><a rel="gsdoc" href="NSSerialization.html#method$NSDeserializer+deserializePropertyListFromData$atCursor$mutableContainers$">+deserializePropertyListFromData:atCursor:mutableContainers:</a></li>
<li><a rel="gsdoc" href="NSSerialization.html#method$NSDeserializer+deserializePropertyListFromData$mutableContainers$">+deserializePropertyListFromData:mutableContainers:</a></li>
<li><a rel="gsdoc" href="NSSerialization.html#method$NSDeserializer+deserializePropertyListLazilyFromData$atCursor$length$mutableContainers$">+deserializePropertyListLazilyFromData:atCursor:length:mutableContainers:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSDeserializer+deserializePropertyListFromData$atCursor$mutableContainers$">deserializePropertyListFromData: atCursor: mutableContainers: </a></h3>
+ (id) <b>deserializePropertyListFromData:</b> (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*)data<b> atCursor:</b> (unsigned int*)cursor<b> mutableContainers:</b> (BOOL)flag;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Recover a property list (NSArray or NSDictionary
plus limited contents) from a byte array.
<em>
Deprecated in favor of
[NSPropertyListSerialization
+propertyListFromData:mutabilityOption:format:errorDescription:].
</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSDeserializer+deserializePropertyListFromData$mutableContainers$">deserializePropertyListFromData: mutableContainers: </a></h3>
+ (id) <b>deserializePropertyListFromData:</b> (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*)data<b> mutableContainers:</b> (BOOL)flag;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Recover a property list (NSArray or NSDictionary
plus limited contents) from a byte array.
<em>
Deprecated in favor of
[NSPropertyListSerialization
+propertyListFromData:mutabilityOption:format:errorDescription:].
</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSDeserializer+deserializePropertyListLazilyFromData$atCursor$length$mutableContainers$">deserializePropertyListLazilyFromData: atCursor: length: mutableContainers: </a></h3>
+ (id) <b>deserializePropertyListLazilyFromData:</b> (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*)data<b> atCursor:</b> (unsigned*)cursor<b> length:</b> (unsigned)length<b> mutableContainers:</b> (BOOL)flag;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Recover a property list (NSArray or NSDictionary
plus limited contents) from a byte array. If the
<var>data</var> at <var>cursor</var> has a
<var>length</var> greater than <var>length</var>, a
proxy is substituted for the actual property list as
<strong>long</strong> as the constituent objects
of that property list are not accessed.
<em>
Deprecated in favor of
[NSPropertyListSerialization
+propertyListFromData:mutabilityOption:format:errorDescription:].
</em>
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="002000000000">
Software documentation for the NSSerializer class
</a></h1>
<h2><a name="class$NSSerializer">NSSerializer</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSSerialization.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
</p>
<p>
<em>
This class is deprecated in favor of
<a rel="gsdoc" href="NSPropertyList.html#class$NSPropertyListSerialization">NSPropertyListSerialization</a>
.</em>
</p>
<p>
</p>
<p>
It provides a means of producing a byte-array
(actually string) representation of a property
list (NSArray or NSDictionary plus limited
contents).
</p>
<p>
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSSerialization.html#method$NSSerializer(GNUstep)+serializePropertyList$intoData$compact$">+serializePropertyList:intoData:compact:</a></li>
<li><a rel="gsdoc" href="NSSerialization.html#method$NSSerializer(GNUstep)+shouldBeCompact$">+shouldBeCompact:</a></li>
<li><a rel="gsdoc" href="NSSerialization.html#method$NSSerializer+serializePropertyList$">+serializePropertyList:</a></li>
<li><a rel="gsdoc" href="NSSerialization.html#method$NSSerializer+serializePropertyList$intoData$">+serializePropertyList:intoData:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSSerializer+serializePropertyList$">serializePropertyList: </a></h3>
+ (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*) <b>serializePropertyList:</b> (id)propertyList;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
</p>
<p>
Serialize given property list (NSArray or
NSDictionary plus limited contents) into
byte array.
</p>
<p>
</p>
<p>
<em>
Deprecated in favor of
<a rel="gsdoc" href="NSPropertyList.html#method$NSPropertyListSerialization+dataFromPropertyList$format$errorDescription$">[NSPropertyListSerialization +dataFromPropertyList:format:errorDescription:]</a>
.
</em>
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSSerializer+serializePropertyList$intoData$">serializePropertyList: intoData: </a></h3>
+ (void) <b>serializePropertyList:</b> (id)propertyList<b> intoData:</b> (<a rel="gsdoc" href="NSData.html#class$NSMutableData">NSMutableData</a>*)d;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
</p>
<p>
Serialize given property list (NSArray or
NSDictionary plus limited contents) into
given mutable byte array.
</p>
<p>
</p>
<p>
<em>
Deprecated in favor of
<a rel="gsdoc" href="NSPropertyList.html#method$NSPropertyListSerialization+dataFromPropertyList$format$errorDescription$">[NSPropertyListSerialization +dataFromPropertyList:format:errorDescription:]</a>
.
</em>
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="003000000000">
Software documentation for the NSDeserializer(GNUstep)
category
</a></h1>
<h2><a rel="gsdoc" href="#class$NSDeserializer">NSDeserializer</a>(<a name="category$NSDeserializer(GNUstep)">GNUstep</a>)</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSSerialization.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
GNUstep extends deserialization by having the
option to make the resulting data more compact by
ensuring that repeated strings are only stored
once. If the property-list has a lot of repeated
strings in it, this will be more space efficient
but it will be slower (though other parts of your code
may speed up through more efficient equality testing of
uniqued strings). The default is NOT to deserialize
uniqued strings.
</p>
<p>
</p>
<p>
The
<a rel="gsdoc" href="#method$NSDeserializer(GNUstep)+uniquing$">
[+uniquing:]
</a>
method turns uniquing on/off. Uniquing is done using
a global
<a rel="gsdoc" href="NSSet.html#class$NSCountedSet">NSCountedSet</a>
- see its documentation for details.
</p>
<p>
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSSerialization.html#method$NSDeserializer(GNUstep)+uniquing$">+uniquing:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSDeserializer(GNUstep)+uniquing$">uniquing: </a></h3>
+ (void) <b>uniquing:</b> (BOOL)flag;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Turns uniquing (collapsing of multiple instances of a
single string in the output to one full copy plus
references) on/off.
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="004000000000">
Software documentation for the NSSerializer(GNUstep)
category
</a></h1>
<h2><a rel="gsdoc" href="#class$NSSerializer">NSSerializer</a>(<a name="category$NSSerializer(GNUstep)">GNUstep</a>)</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSSerialization.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Base<br />
Likely to be changed/moved/removed at 1.17.0</div>
<br />
<div class="desc">
GNUstep extends serialization by having the option to
make the resulting data more compact by ensuring that
repeated strings are only stored once. If the
property-list has a lot of repeated strings in
it, this will be both faster and more space efficient but
it will be slower if the property-list has few repeated
strings. The default is NOT to generate compact
versions of the data. The
<a rel="gsdoc" href="#method$NSSerializer(GNUstep)+shouldBeCompact$">
[+shouldBeCompact:]
</a>
method sets default behavior. The
<a rel="gsdoc" href="#method$NSSerializer(GNUstep)+serializePropertyList$intoData$compact$">[+serializePropertyList:intoData:compact:]</a>
method lets you override the default behavior.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSSerialization.html#method$NSSerializer(GNUstep)+serializePropertyList$intoData$compact$">+serializePropertyList:intoData:compact:</a></li>
<li><a rel="gsdoc" href="NSSerialization.html#method$NSSerializer(GNUstep)+shouldBeCompact$">+shouldBeCompact:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSSerializer(GNUstep)+serializePropertyList$intoData$compact$">serializePropertyList: intoData: compact: </a></h3>
+ (void) <b>serializePropertyList:</b> (id)propertyList<b> intoData:</b> (<a rel="gsdoc" href="NSData.html#class$NSMutableData">NSMutableData</a>*)d<b> compact:</b> (BOOL)flag;<br />
<div class="availability">
<b>Availability:</b> Base<br />
Likely to be changed/moved/removed at 1.17.0</div>
<br />
<div class="desc">
As
<a rel="gsdoc" href="#method$NSSerializer+serializePropertyList$intoData$">[NSSerializer +serializePropertyList:intoData:]</a>
but specify whether to produce compacted format.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSSerializer(GNUstep)+shouldBeCompact$">shouldBeCompact: </a></h3>
+ (void) <b>shouldBeCompact:</b> (BOOL)flag;<br />
<div class="availability">
<b>Availability:</b> Base<br />
Likely to be changed/moved/removed at 1.17.0</div>
<br />
<div class="desc">
Specify whether to produce compacted format, with
repeated strings only written once.
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="005000000000">
Software documentation for the
NSObjCTypeSerializationCallBack
protocol
</a></h1>
<h2><a name="protocol$(NSObjCTypeSerializationCallBack)">NSObjCTypeSerializationCallBack</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSSerialization.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Objects that are not standard property list
constituents can adopt this protocol to allow
themselves to be serialized by an
<a rel="gsdoc" href="#class$NSSerializer">NSSerializer</a>
and deserialized by an
<a rel="gsdoc" href="#class$NSDeserializer">NSDeserializer</a>
.
<em>
Note, this mechanism has been deprecated and you
should instead use
<a rel="gsdoc" href="NSArchiver.html#class$NSArchiver">NSArchiver</a>
and related facilities to serialize objects that
are not ordinary property lists.
</em>
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSSerialization.html#method$(NSObjCTypeSerializationCallBack)-deserializeObjectAt$ofObjCType$fromData$atCursor$">-deserializeObjectAt:ofObjCType:fromData:atCursor:</a></li>
<li><a rel="gsdoc" href="NSSerialization.html#method$(NSObjCTypeSerializationCallBack)-serializeObjectAt$ofObjCType$intoData$">-serializeObjectAt:ofObjCType:intoData:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$(NSObjCTypeSerializationCallBack)-deserializeObjectAt$ofObjCType$fromData$atCursor$">deserializeObjectAt: ofObjCType: fromData: atCursor: </a></h3>
- (void) <b>deserializeObjectAt:</b> (id*)object<b> ofObjCType:</b> (const char*)type<b> fromData:</b> (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*)data<b> atCursor:</b> (unsigned*)cursor;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Decodes an <var>object</var> of given
<var>type</var> from <var>data</var> at position
<var>cursor</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$(NSObjCTypeSerializationCallBack)-serializeObjectAt$ofObjCType$intoData$">serializeObjectAt: ofObjCType: intoData: </a></h3>
- (void) <b>serializeObjectAt:</b> (id*)object<b> ofObjCType:</b> (const char*)type<b> intoData:</b> (<a rel="gsdoc" href="NSData.html#class$NSMutableData">NSMutableData</a>*)data;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Encode the given <var>object</var> of given
<var>type</var> into <var>data</var>, using a string
not a binary representation.
</div>
<hr width="25%" align="left" />
</div>
<br />
<a href="Base.html">Up</a>
</font>
</body>
</html>
|