-
Notifications
You must be signed in to change notification settings - Fork 42
/
NSDataReadingOptions.xml
136 lines (136 loc) · 6.09 KB
/
NSDataReadingOptions.xml
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
<Type Name="NSDataReadingOptions" FullName="Foundation.NSDataReadingOptions">
<TypeSignature Language="C#" Value="public enum NSDataReadingOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed NSDataReadingOptions extends System.Enum" />
<TypeSignature Language="DocId" Value="T:Foundation.NSDataReadingOptions" />
<TypeSignature Language="F#" Value="type NSDataReadingOptions = " />
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.Native</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Flags</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Flags that determine how NSData loads files.</summary>
<remarks>
<para>
By default NSData will loads the contents of the file in memory
by allocating a block of memory and then reading the contents of
the file into it.
</para>
<para>
The Mapped and MappedAlways parameter instruct NSData to use
the kernel's interface to map the file into the process
address space. This has a few advantages: instead of
allocating read/write memory for the process, that becomes
real memory usage, the mapped versions map the file into
memory which means that the data is loaded on demand instead
of being loaded upfront. This also allows the kernel to
discard the data loaded from memory when the system is running
low on memory.
</para>
</remarks>
</Docs>
<Members>
<Member MemberName="Coordinated">
<MemberSignature Language="C#" Value="Coordinated" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Foundation.NSDataReadingOptions Coordinated = unsigned int64(4)" />
<MemberSignature Language="DocId" Value="F:Foundation.NSDataReadingOptions.Coordinated" />
<MemberSignature Language="F#" Value="Coordinated = 4" Usage="Foundation.NSDataReadingOptions.Coordinated" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Foundation.NSDataReadingOptions</ReturnType>
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>To be added.</summary>
</Docs>
</Member>
<Member MemberName="Mapped">
<MemberSignature Language="C#" Value="Mapped" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Foundation.NSDataReadingOptions Mapped = unsigned int64(1)" />
<MemberSignature Language="DocId" Value="F:Foundation.NSDataReadingOptions.Mapped" />
<MemberSignature Language="F#" Value="Mapped = 1" Usage="Foundation.NSDataReadingOptions.Mapped" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Foundation.NSDataReadingOptions</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Use the kernel's virtual memory map to load the file, if possible. If sucessful, this replaces read/write memory that can be very expensive with discardable memory that is backed by a file.</summary>
</Docs>
</Member>
<Member MemberName="MappedAlways">
<MemberSignature Language="C#" Value="MappedAlways" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Foundation.NSDataReadingOptions MappedAlways = unsigned int64(8)" />
<MemberSignature Language="DocId" Value="F:Foundation.NSDataReadingOptions.MappedAlways" />
<MemberSignature Language="F#" Value="MappedAlways = 8" Usage="Foundation.NSDataReadingOptions.MappedAlways" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Foundation.NSDataReadingOptions</ReturnType>
</ReturnValue>
<MemberValue>8</MemberValue>
<Docs>
<summary>Force NSData to try to use the kernel's mapping support to load the file. If sucessful, this replaces read/write memory that can be very expensive with discardable memory that is backed by a file.</summary>
</Docs>
</Member>
<Member MemberName="Uncached">
<MemberSignature Language="C#" Value="Uncached" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Foundation.NSDataReadingOptions Uncached = unsigned int64(2)" />
<MemberSignature Language="DocId" Value="F:Foundation.NSDataReadingOptions.Uncached" />
<MemberSignature Language="F#" Value="Uncached = 2" Usage="Foundation.NSDataReadingOptions.Uncached" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Foundation.NSDataReadingOptions</ReturnType>
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>Notify the kernel that it should not try to cache the contents of this file in its buffer cache.</summary>
</Docs>
</Member>
</Members>
</Type>