/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSSerialization.gsdoc is in gnustep-base-doc 1.25.1-2ubuntu3.
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 | <?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.4//EN" "http://www.gnustep.org/gsdoc-1_0_4.dtd">
<gsdoc base="NSSerialization" up="Base">
<head>
<title>NSSerialization documentation</title>
<author name="Generated by Debian"></author>
</head>
<body>
<front><contents /></front>
<chapter>
<heading>
Software documentation for the NSDeserializer class
</heading>
<class name="NSDeserializer" super="NSObject" ovadd="1.0.0">
<declared>Foundation/NSSerialization.h</declared>
<desc>
<em>
This class is deprecated in favor of
<ref type="class" id="NSPropertyListSerialization">NSPropertyListSerialization</ref>.</em> It provides a means of recovering a property list (NSArray or NSDictionary plus limited contents) from a byte-array (actually string) representation.
</desc>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>deserializePropertyListFromData:</sel>
<arg type="NSData*">data</arg>
<sel>atCursor:</sel>
<arg type="unsigned int*">cursor</arg>
<sel>mutableContainers:</sel>
<arg type="BOOL">flag</arg>
<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>
</desc>
</method>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>deserializePropertyListFromData:</sel>
<arg type="NSData*">data</arg>
<sel>mutableContainers:</sel>
<arg type="BOOL">flag</arg>
<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>
</desc>
</method>
<method type="id" factory="yes" ovadd="1.0.0">
<sel>deserializePropertyListLazilyFromData:</sel>
<arg type="NSData*">data</arg>
<sel>atCursor:</sel>
<arg type="unsigned*">cursor</arg>
<sel>length:</sel>
<arg type="unsigned">length</arg>
<sel>mutableContainers:</sel>
<arg type="BOOL">flag</arg>
<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>
</desc>
</method>
</class>
</chapter>
<chapter>
<heading>
Software documentation for the NSSerializer class
</heading>
<class name="NSSerializer" super="NSObject" ovadd="1.0.0">
<declared>Foundation/NSSerialization.h</declared>
<desc>
<p>
<em>
This class is deprecated in favor of
<ref type="class" id="NSPropertyListSerialization">NSPropertyListSerialization</ref>.</em>
</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>
</desc>
<method type="NSData*" factory="yes" ovadd="1.0.0">
<sel>serializePropertyList:</sel>
<arg type="id">propertyList</arg>
<desc>
<p>
Serialize given property list (NSArray or
NSDictionary plus limited contents) into
byte array.
</p>
<p>
<em>
Deprecated in favor of
<ref type="method" id="+dataFromPropertyList:format:errorDescription:" class="NSPropertyListSerialization">[NSPropertyListSerialization +dataFromPropertyList:format:errorDescription:]</ref>.
</em>
</p>
</desc>
</method>
<method type="void" factory="yes" ovadd="1.0.0">
<sel>serializePropertyList:</sel>
<arg type="id">propertyList</arg>
<sel>intoData:</sel>
<arg type="NSMutableData*">d</arg>
<desc>
<p>
Serialize given property list (NSArray or
NSDictionary plus limited contents) into
given mutable byte array.
</p>
<p>
<em>
Deprecated in favor of
<ref type="method" id="+dataFromPropertyList:format:errorDescription:" class="NSPropertyListSerialization">[NSPropertyListSerialization +dataFromPropertyList:format:errorDescription:]</ref>.
</em>
</p>
</desc>
</method>
</class>
</chapter>
<chapter>
<heading>
Software documentation for the NSDeserializer(GNUstep)
category
</heading>
<category name="GNUstep" class="NSDeserializer" ovadd="0.0.0" ovrem="0.0.0">
<declared>Foundation/NSSerialization.h</declared>
<desc>
<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>
The
<ref type="method" id="+uniquing:">
[+uniquing:]
</ref>
method turns uniquing on/off. Uniquing is done using
a global
<ref type="class" id="NSCountedSet">NSCountedSet</ref>
- see its documentation for details.
</p>
</desc>
<method type="void" factory="yes" ovadd="0.0.0" ovrem="0.0.0">
<sel>uniquing:</sel>
<arg type="BOOL">flag</arg>
<desc>
Turns uniquing (collapsing of multiple instances of a
single string in the output to one full copy plus
references) on/off.
</desc>
</method>
</category>
</chapter>
<chapter>
<heading>
Software documentation for the NSSerializer(GNUstep)
category
</heading>
<category name="GNUstep" class="NSSerializer" gvadd="0.0.0" gvrem="1.17.0">
<declared>Foundation/NSSerialization.h</declared>
<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
<ref type="method" id="+shouldBeCompact:">
[+shouldBeCompact:]
</ref>
method sets default behavior. The
<ref type="method" id="+serializePropertyList:intoData:compact:">[+serializePropertyList:intoData:compact:]</ref> method lets you override the default behavior.
</desc>
<method type="void" factory="yes" gvadd="0.0.0" gvrem="1.17.0">
<sel>serializePropertyList:</sel>
<arg type="id">propertyList</arg>
<sel>intoData:</sel>
<arg type="NSMutableData*">d</arg>
<sel>compact:</sel>
<arg type="BOOL">flag</arg>
<desc>
As
<ref type="method" id="+serializePropertyList:intoData:" class="NSSerializer">[NSSerializer +serializePropertyList:intoData:]</ref> but specify whether to produce compacted format.
</desc>
</method>
<method type="void" factory="yes" gvadd="0.0.0" gvrem="1.17.0">
<sel>shouldBeCompact:</sel>
<arg type="BOOL">flag</arg>
<desc>
Specify whether to produce compacted format, with
repeated strings only written once.
</desc>
</method>
</category>
</chapter>
<chapter>
<heading>
Software documentation for the
NSObjCTypeSerializationCallBack
protocol
</heading>
<protocol name="NSObjCTypeSerializationCallBack" ovadd="1.0.0">
<declared>Foundation/NSSerialization.h</declared>
<desc>
Objects that are not standard property list
constituents can adopt this protocol to allow
themselves to be serialized by an
<ref type="class" id="NSSerializer">NSSerializer</ref>
and deserialized by an
<ref type="class" id="NSDeserializer">NSDeserializer</ref>
.
<em>
Note, this mechanism has been deprecated and you
should instead use
<ref type="class" id="NSArchiver">NSArchiver</ref>
and related facilities to serialize objects that
are not ordinary property lists.
</em>
</desc>
<method type="void" ovadd="1.0.0">
<sel>deserializeObjectAt:</sel>
<arg type="id*">object</arg>
<sel>ofObjCType:</sel>
<arg type="const char*">type</arg>
<sel>fromData:</sel>
<arg type="NSData*">data</arg>
<sel>atCursor:</sel>
<arg type="unsigned*">cursor</arg>
<desc>
Decodes an <var>object</var> of given
<var>type</var> from <var>data</var> at position
<var>cursor</var>.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>serializeObjectAt:</sel>
<arg type="id*">object</arg>
<sel>ofObjCType:</sel>
<arg type="const char*">type</arg>
<sel>intoData:</sel>
<arg type="NSMutableData*">data</arg>
<desc>
Encode the given <var>object</var> of given
<var>type</var> into <var>data</var>, using a string
not a binary representation.
</desc>
</method>
</protocol>
</chapter>
</body>
</gsdoc>
|