-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
PaxTarEntry.xml
226 lines (198 loc) · 15.1 KB
/
PaxTarEntry.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
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
<Type Name="PaxTarEntry" FullName="System.Formats.Tar.PaxTarEntry">
<TypeSignature Language="C#" Value="public sealed class PaxTarEntry : System.Formats.Tar.PosixTarEntry" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit PaxTarEntry extends System.Formats.Tar.PosixTarEntry" />
<TypeSignature Language="DocId" Value="T:System.Formats.Tar.PaxTarEntry" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class PaxTarEntry
Inherits PosixTarEntry" />
<TypeSignature Language="F#" Value="type PaxTarEntry = class
 inherit PosixTarEntry" />
<TypeSignature Language="C++ CLI" Value="public ref class PaxTarEntry sealed : System::Formats::Tar::PosixTarEntry" />
<AssemblyInfo>
<AssemblyName>System.Formats.Tar</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Formats.Tar.PosixTarEntry</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a tar entry in the PAX format.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PaxTarEntry (System.Formats.Tar.TarEntry other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Formats.Tar.TarEntry other) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Tar.PaxTarEntry.#ctor(System.Formats.Tar.TarEntry)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (other As TarEntry)" />
<MemberSignature Language="F#" Value="new System.Formats.Tar.PaxTarEntry : System.Formats.Tar.TarEntry -> System.Formats.Tar.PaxTarEntry" Usage="new System.Formats.Tar.PaxTarEntry other" />
<MemberSignature Language="C++ CLI" Value="public:
 PaxTarEntry(System::Formats::Tar::TarEntry ^ other);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Tar</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="other" Type="System.Formats.Tar.TarEntry" />
</Parameters>
<Docs>
<param name="other">The <see cref="T:System.Formats.Tar.TarEntry" /> instance to convert to the PAX format.</param>
<summary>Initializes a new <see cref="T:System.Formats.Tar.PaxTarEntry" /> instance by converting the specified <paramref name="other" /> entry into the PAX format.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="other" /> is a <see cref="T:System.Formats.Tar.PaxGlobalExtendedAttributesTarEntry" /> instance.
-or-
The entry type of <paramref name="other" /> is not supported in the PAX format.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PaxTarEntry (System.Formats.Tar.TarEntryType entryType, string entryName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Formats.Tar.TarEntryType entryType, string entryName) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Tar.PaxTarEntry.#ctor(System.Formats.Tar.TarEntryType,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (entryType As TarEntryType, entryName As String)" />
<MemberSignature Language="F#" Value="new System.Formats.Tar.PaxTarEntry : System.Formats.Tar.TarEntryType * string -> System.Formats.Tar.PaxTarEntry" Usage="new System.Formats.Tar.PaxTarEntry (entryType, entryName)" />
<MemberSignature Language="C++ CLI" Value="public:
 PaxTarEntry(System::Formats::Tar::TarEntryType entryType, System::String ^ entryName);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Tar</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="entryType" Type="System.Formats.Tar.TarEntryType" />
<Parameter Name="entryName" Type="System.String" />
</Parameters>
<Docs>
<param name="entryType">The type of the entry.</param>
<param name="entryName">A string with the path and file name of this entry.</param>
<summary>Initializes a new <see cref="T:System.Formats.Tar.PaxTarEntry" /> instance with the specified entry type and entry name, and the default extended attributes.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When creating an instance using the <xref:System.Formats.Tar.PaxTarEntry.%23ctor(System.Formats.Tar.TarEntryType,System.String)> constructor, only the following entry types are supported: <xref:System.Formats.Tar.TarEntryType.Directory>, <xref:System.Formats.Tar.TarEntryType.HardLink>, <xref:System.Formats.Tar.TarEntryType.SymbolicLink>, <xref:System.Formats.Tar.TarEntryType.RegularFile>, <xref:System.Formats.Tar.TarEntryType.BlockDevice>, <xref:System.Formats.Tar.TarEntryType.CharacterDevice>, and <xref:System.Formats.Tar.TarEntryType.Fifo>.
Use the <xref:System.Formats.Tar.PaxTarEntry.%23ctor(System.Formats.Tar.TarEntryType,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})> constructor to include additional extended attributes when creating the entry.
The following entries are always found in the extended attributes dictionary of any PAX entry:
- Modification time, under the name `mtime`, as a <xref:System.Double> number.
- Access time, under the name `atime`, as a <xref:System.Double> number.
- Change time, under the name `ctime`, as a <xref:System.Double> number.
- Path, under the name `path`, as a string.
The following entries are only found in the extended attributes dictionary of a PAX entry if certain conditions are met:
- Group name, under the name `gname`, as a string, if it is larger than 32 bytes.
- User name, under the name `uname`, as a string, if it is larger than 32 bytes.
- File length, under the name `size`, as an <xref:System.Int32>, if the string representation of the number is larger than 12 bytes.
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="entryName" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="entryName" /> is empty.
-or-
The entry type is not supported for creating an entry in the PAX format.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PaxTarEntry (System.Formats.Tar.TarEntryType entryType, string entryName, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,string>> extendedAttributes);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Formats.Tar.TarEntryType entryType, string entryName, class System.Collections.Generic.IEnumerable`1<valuetype System.Collections.Generic.KeyValuePair`2<string, string>> extendedAttributes) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Tar.PaxTarEntry.#ctor(System.Formats.Tar.TarEntryType,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (entryType As TarEntryType, entryName As String, extendedAttributes As IEnumerable(Of KeyValuePair(Of String, String)))" />
<MemberSignature Language="F#" Value="new System.Formats.Tar.PaxTarEntry : System.Formats.Tar.TarEntryType * string * seq<System.Collections.Generic.KeyValuePair<string, string>> -> System.Formats.Tar.PaxTarEntry" Usage="new System.Formats.Tar.PaxTarEntry (entryType, entryName, extendedAttributes)" />
<MemberSignature Language="C++ CLI" Value="public:
 PaxTarEntry(System::Formats::Tar::TarEntryType entryType, System::String ^ entryName, System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<System::String ^, System::String ^>> ^ extendedAttributes);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Tar</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="entryType" Type="System.Formats.Tar.TarEntryType" />
<Parameter Name="entryName" Type="System.String" />
<Parameter Name="extendedAttributes" Type="System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String,System.String>>">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0, 1, 1 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0, 1, 1 })>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="entryType">The type of the entry.</param>
<param name="entryName">A string with the path and file name of this entry.</param>
<param name="extendedAttributes">An enumeration of string key-value pairs that represents the metadata to include in the extended attributes entry that precedes the current entry.</param>
<summary>Initializes a new <see cref="T:System.Formats.Tar.PaxTarEntry" /> instance with the specified entry type, entry name, and extended attributes enumeration.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this constructor to include additional extended attributes when creating the entry.
The following entries are always found in the extended attributes dictionary of any PAX entry:
- Modification time, under the name `mtime`, as a <xref:System.Double> number.
- Access time, under the name `atime`, as a <xref:System.Double> number.
- Change time, under the name `ctime`, as a <xref:System.Double> number.
- Path, under the name `path`, as a string.
The following entries are only found in the extended attributes dictionary of a PAX entry if certain conditions are met:
- Group name, under the name `gname`, as a string, if it is larger than 32 bytes.
- User name, under the name `uname`, as a string, if it is larger than 32 bytes.
- File length, under the name `size`, as an <xref:System.Int32>, if the string representation of the number is larger than 12 bytes.
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="extendedAttributes" /> or <paramref name="entryName" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="entryName" /> is empty.
-or-
The entry type is not supported for creating an entry in the PAX format.</exception>
</Docs>
</Member>
<Member MemberName="ExtendedAttributes">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyDictionary<string,string> ExtendedAttributes { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyDictionary`2<string, string> ExtendedAttributes" />
<MemberSignature Language="DocId" Value="P:System.Formats.Tar.PaxTarEntry.ExtendedAttributes" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExtendedAttributes As IReadOnlyDictionary(Of String, String)" />
<MemberSignature Language="F#" Value="member this.ExtendedAttributes : System.Collections.Generic.IReadOnlyDictionary<string, string>" Usage="System.Formats.Tar.PaxTarEntry.ExtendedAttributes" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::IReadOnlyDictionary<System::String ^, System::String ^> ^ ExtendedAttributes { System::Collections::Generic::IReadOnlyDictionary<System::String ^, System::String ^> ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Tar</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyDictionary<System.String,System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the extended attributes for this entry.</summary>
<value>To be added.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The extended attributes are specified when constructing an entry. Use <xref:System.Formats.Tar.PaxTarEntry.%23ctor(System.Formats.Tar.TarEntryType,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})> to append your own enumeration of extended attributes to the current entry on top of the default ones. Use <xref:System.Formats.Tar.PaxTarEntry.%23ctor(System.Formats.Tar.TarEntryType,System.String)> to only use the default extended attributes.
The following entries are always found in the extended attributes dictionary of any PAX entry:
- Modification time, under the name `mtime`, as a <xref:System.Double> number.
- Access time, under the name `atime`, as a <xref:System.Double> number.
- Change time, under the name `ctime`, as a <xref:System.Double> number.
- Path, under the name `path`, as a string.
The following entries are only found in the extended attributes dictionary of a PAX entry if certain conditions are met:
- Group name, under the name `gname`, as a string, if it is larger than 32 bytes.
- User name, under the name `uname`, as a string, if it is larger than 32 bytes.
- File length, under the name `size`, as an <xref:System.Int32>, if the string representation of the number is larger than 12 bytes.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>