219 references to TarEntryFormat
System.Formats.Tar (219)
System\Formats\Tar\GnuTarEntry.cs (4)
9/// <remarks>Even though the <see cref="TarEntryFormat.Gnu"/> format is not POSIX compatible, it implements and supports the Unix-specific fields that were defined in the POSIX IEEE P1003.1 standard from 1988: <c>devmajor</c>, <c>devminor</c>, <c>gname</c> and <c>uname</c>.</remarks> 14: base(header, readerOfOrigin, TarEntryFormat.Gnu) 34: base(entryType, entryName, TarEntryFormat.Gnu, isGea: false) 47: base(other, TarEntryFormat.Gnu)
System\Formats\Tar\PaxGlobalExtendedAttributesTarEntry.cs (2)
18: base(header, readerOfOrigin, TarEntryFormat.Pax) 28: base(TarEntryType.GlobalExtendedAttributes, nameof(PaxGlobalExtendedAttributesTarEntry), TarEntryFormat.Pax, isGea: true) // Name == name of type for lack of a better temporary name until the entry is written
System\Formats\Tar\PaxTarEntry.cs (6)
19: base(header, readerOfOrigin, TarEntryFormat.Pax) 53: base(entryType, entryName, TarEntryFormat.Pax, isGea: false) 92: base(entryType, entryName, TarEntryFormat.Pax, isGea: false) 110: base(other, TarEntryFormat.Pax) 112if (other._header._format is TarEntryFormat.Ustar or TarEntryFormat.Pax)
System\Formats\Tar\PosixTarEntry.cs (11)
9/// Abstract class that represents a tar entry from an archive of a format that is based on the POSIX IEEE P1003.1 standard from 1988. This includes the formats <see cref="TarEntryFormat.Ustar"/> (represented by the <see cref="UstarTarEntry"/> class), <see cref="TarEntryFormat.Pax"/> (represented by the <see cref="PaxTarEntry"/> class) and <see cref="TarEntryFormat.Gnu"/> (represented by the <see cref="GnuTarEntry"/> class). 12/// Even though the <see cref="TarEntryFormat.Gnu"/> format is not POSIX compatible, it implements and supports the Unix-specific fields that were defined in that POSIX standard.</remarks> 16internal PosixTarEntry(TarHeader header, TarReader readerOfOrigin, TarEntryFormat format) 22internal PosixTarEntry(TarEntryType entryType, string entryName, TarEntryFormat format, bool isGea) 32internal PosixTarEntry(TarEntry other, TarEntryFormat format) 53/// <exception cref="ArgumentOutOfRangeException">The value is negative, or larger than 2097151 when using <see cref="TarEntryFormat.V7"/> or <see cref="TarEntryFormat.Ustar"/>.</exception> 79/// <exception cref="ArgumentOutOfRangeException">The value is negative, or larger than 2097151 when using <see cref="TarEntryFormat.V7"/> or <see cref="TarEntryFormat.Ustar"/>.</exception>
System\Formats\Tar\TarEntry.cs (14)
15/// <remarks>All the properties exposed by this class are supported by the <see cref="TarEntryFormat.V7"/>, <see cref="TarEntryFormat.Ustar"/>, <see cref="TarEntryFormat.Pax"/> and <see cref="TarEntryFormat.Gnu"/> formats.</remarks> 24protected bool FormatIsOctalOnly => _header._format is TarEntryFormat.V7 or TarEntryFormat.Ustar; 27internal TarEntry(TarHeader header, TarReader readerOfOrigin, TarEntryFormat format) 37internal TarEntry(TarEntryType entryType, string entryName, TarEntryFormat format, bool isGea) 53internal TarEntry(TarEntry other, TarEntryFormat format) 82public TarEntryFormat Format => _header._format; 98/// <exception cref="ArgumentOutOfRangeException">The specified value is larger than <see cref="DateTimeOffset.UnixEpoch"/> when using <see cref="TarEntryFormat.V7"/> or <see cref="TarEntryFormat.Ustar"/>.</exception> 115/// <remarks>The entry type that commonly contains data is <see cref="TarEntryType.RegularFile"/> (or <see cref="TarEntryType.V7RegularFile"/> in the <see cref="TarEntryFormat.V7"/> format). Other uncommon entry types that can also contain data are: <see cref="TarEntryType.ContiguousFile"/>, <see cref="TarEntryType.DirectoryList"/>, <see cref="TarEntryType.MultiVolume"/> and <see cref="TarEntryType.SparseFile"/>.</remarks> 250/// <exception cref="InvalidOperationException">Setting a data section is not supported because the <see cref="EntryType"/> is not <see cref="TarEntryType.RegularFile"/> (or <see cref="TarEntryType.V7RegularFile"/> for an archive of <see cref="TarEntryFormat.V7"/> format).</exception>
System\Formats\Tar\TarEntryType.cs (10)
14/// <para>This entry type is specific to the <see cref="TarEntryFormat.Ustar"/>, <see cref="TarEntryFormat.Pax"/> and <see cref="TarEntryFormat.Gnu"/> formats.</para> 46/// <para>This entry type is specific to the <see cref="TarEntryFormat.Gnu"/> format, and is treated as a <see cref="RegularFile"/> entry type.</para> 62/// <para>This entry type is specific to the <see cref="TarEntryFormat.Gnu"/> format, and is treated as a <see cref="Directory"/> entry type that contains a data section.</para> 77/// <para>This entry type is specific to the <see cref="TarEntryFormat.Gnu"/> format and is not supported for writing.</para> 82/// <para>This entry type is specific to the <see cref="TarEntryFormat.V7"/> format.</para> 87/// <para>This entry type is specific to the <see cref="TarEntryFormat.Gnu"/> format. It is considered unsafe and is ignored by other tools.</para> 92/// <para>This entry type is specific to the <see cref="TarEntryFormat.Gnu"/> format and is not supported for writing.</para> 97/// <para>This entry type is specific to the <see cref="TarEntryFormat.Gnu"/> format and is not supported for writing.</para>
System\Formats\Tar\TarFile.cs (2)
330using (TarWriter writer = new TarWriter(destination, TarEntryFormat.Pax, leaveOpen)) 384TarWriter writer = new TarWriter(destination, TarEntryFormat.Pax, leaveOpen);
System\Formats\Tar\TarHeader.cs (11)
48internal TarEntryFormat _format; 90internal TarHeader(TarEntryFormat format, string name = "", int mode = 0, DateTimeOffset mTime = default, TarEntryType typeFlag = TarEntryType.RegularFile) 104internal TarHeader(TarEntryFormat format, TarEntryType typeFlag, TarHeader other) 141private static string GetMagicForFormat(TarEntryFormat format) => format switch 143TarEntryFormat.Ustar or TarEntryFormat.Pax => UstarMagic, 144TarEntryFormat.Gnu => GnuMagic, 148private static string GetVersionForFormat(TarEntryFormat format) => format switch 150TarEntryFormat.Ustar or TarEntryFormat.Pax => UstarVersion, 151TarEntryFormat.Gnu => GnuVersion,
System\Formats\Tar\TarHeader.Read.cs (24)
21internal static TarHeader? TryGetNextHeader(Stream archiveStream, bool copyData, TarEntryFormat initialFormat, bool processDataBlock) 40internal static async ValueTask<TarHeader?> TryGetNextHeaderAsync(Stream archiveStream, bool copyData, TarEntryFormat initialFormat, bool processDataBlock, CancellationToken cancellationToken) 61private static TarHeader? TryReadAttributes(TarEntryFormat initialFormat, ReadOnlySpan<byte> buffer, Stream archiveStream) 70if (header._format != TarEntryFormat.V7) 78Debug.Assert(header._format is TarEntryFormat.Ustar or TarEntryFormat.Pax or TarEntryFormat.Gnu); 79if (header._format == TarEntryFormat.Ustar) 83else if (header._format == TarEntryFormat.Gnu) 362private static TarHeader? TryReadCommonAttributes(ReadOnlySpan<byte> buffer, TarEntryFormat initialFormat) 399if (header._format == TarEntryFormat.Unknown) 404TarEntryType.GlobalExtendedAttributes => TarEntryFormat.Pax, 411TarEntryType.TapeVolume => TarEntryFormat.Gnu, 414TarEntryType.V7RegularFile => TarEntryFormat.V7, 420_ => (header._typeFlag == TarEntryType.RegularFile) ? TarEntryFormat.Ustar : TarEntryFormat.V7 436_format = TarEntryFormat.V7; 444_format = TarEntryFormat.Gnu; 449if (_format == TarEntryFormat.V7) 452_format = TarEntryFormat.Ustar; 465if (_format == TarEntryFormat.V7) 473case TarEntryFormat.Ustar or TarEntryFormat.Pax: 491case TarEntryFormat.Gnu:
System\Formats\Tar\TarHeader.Write.cs (59)
33private void WriteWithSeekableDataStream(TarEntryFormat format, Stream archiveStream, Span<byte> buffer) 35Debug.Assert(format is > TarEntryFormat.Unknown and <= TarEntryFormat.Gnu); 49private async Task WriteWithSeekableDataStreamAsync(TarEntryFormat format, Stream archiveStream, Memory<byte> buffer, CancellationToken cancellationToken) 51Debug.Assert(format is > TarEntryFormat.Unknown and <= TarEntryFormat.Gnu); 65private void WriteWithUnseekableDataStream(TarEntryFormat format, Stream destinationStream, Span<byte> buffer, bool shouldAdvanceToEnd) 77TarEntryFormat.V7 => FieldLocations.V7Data, 78TarEntryFormat.Ustar or TarEntryFormat.Pax => FieldLocations.PosixData, 79TarEntryFormat.Gnu => FieldLocations.GnuData, 117private async Task WriteWithUnseekableDataStreamAsync(TarEntryFormat format, Stream destinationStream, Memory<byte> buffer, bool shouldAdvanceToEnd, CancellationToken cancellationToken) 129TarEntryFormat.V7 => FieldLocations.V7Data, 130TarEntryFormat.Ustar or TarEntryFormat.Pax => FieldLocations.PosixData, 131TarEntryFormat.Gnu => FieldLocations.GnuData, 171TarEntryType actualEntryType = TarHelpers.GetCorrectTypeFlagForFormat(TarEntryFormat.V7, _typeFlag); 181TarEntryType actualEntryType = TarHelpers.GetCorrectTypeFlagForFormat(TarEntryFormat.Ustar, _typeFlag); 223WriteWithUnseekableDataStream(TarEntryFormat.V7, archiveStream, buffer, shouldAdvanceToEnd: true); 227WriteWithSeekableDataStream(TarEntryFormat.V7, archiveStream, buffer); 237return WriteWithUnseekableDataStreamAsync(TarEntryFormat.V7, archiveStream, buffer, shouldAdvanceToEnd: true, cancellationToken); 241return WriteWithSeekableDataStreamAsync(TarEntryFormat.V7, archiveStream, buffer, cancellationToken); 250WriteWithUnseekableDataStream(TarEntryFormat.Ustar, archiveStream, buffer, shouldAdvanceToEnd: true); 254WriteWithSeekableDataStream(TarEntryFormat.Ustar, archiveStream, buffer); 264return WriteWithUnseekableDataStreamAsync(TarEntryFormat.Ustar, archiveStream, buffer, shouldAdvanceToEnd: true, cancellationToken); 268return WriteWithSeekableDataStreamAsync(TarEntryFormat.Ustar, archiveStream, buffer, cancellationToken); 279TarHeader extendedAttributesHeader = new(TarEntryFormat.Pax); 286WriteWithUnseekableDataStream(TarEntryFormat.Pax, tempStream, buffer, shouldAdvanceToEnd: false); 310WriteWithSeekableDataStream(TarEntryFormat.Pax, archiveStream, buffer); 323TarHeader extendedAttributesHeader = new(TarEntryFormat.Pax); 330await WriteWithUnseekableDataStreamAsync(TarEntryFormat.Pax, tempStream, buffer, shouldAdvanceToEnd: false, cancellationToken).ConfigureAwait(false); 354await WriteWithSeekableDataStreamAsync(TarEntryFormat.Pax, archiveStream, buffer, cancellationToken).ConfigureAwait(false); 369longLinkHeader.WriteWithSeekableDataStream(TarEntryFormat.Gnu, archiveStream, buffer); 378longPathHeader.WriteWithSeekableDataStream(TarEntryFormat.Gnu, archiveStream, buffer); 385WriteWithUnseekableDataStream(TarEntryFormat.Gnu, archiveStream, buffer, shouldAdvanceToEnd: true); 389WriteWithSeekableDataStream(TarEntryFormat.Gnu, archiveStream, buffer); 405await longLinkHeader.WriteWithSeekableDataStreamAsync(TarEntryFormat.Gnu, archiveStream, buffer, cancellationToken).ConfigureAwait(false); 414await longPathHeader.WriteWithSeekableDataStreamAsync(TarEntryFormat.Gnu, archiveStream, buffer, cancellationToken).ConfigureAwait(false); 421await WriteWithUnseekableDataStreamAsync(TarEntryFormat.Gnu, archiveStream, buffer, shouldAdvanceToEnd: true, cancellationToken).ConfigureAwait(false); 425await WriteWithSeekableDataStreamAsync(TarEntryFormat.Gnu, archiveStream, buffer, cancellationToken).ConfigureAwait(false); 434return new(TarEntryFormat.Gnu) 450tmpChecksum += WriteCommonFields(buffer, TarHelpers.GetCorrectTypeFlagForFormat(TarEntryFormat.Gnu, _typeFlag)); 463WriteWithSeekableDataStream(TarEntryFormat.Pax, archiveStream, buffer); 472return WriteWithSeekableDataStreamAsync(TarEntryFormat.Pax, archiveStream, buffer, cancellationToken); 493tmpChecksum += WriteCommonFields(buffer, TarHelpers.GetCorrectTypeFlagForFormat(TarEntryFormat.Pax, _typeFlag)); 501private void WriteFieldsToBuffer(TarEntryFormat format, Span<byte> buffer) 505case TarEntryFormat.V7: 508case TarEntryFormat.Ustar: 511case TarEntryFormat.Pax: 514case TarEntryFormat.Gnu: 529if (_format is TarEntryFormat.V7) 649if (_format is not TarEntryFormat.Pax and not TarEntryFormat.Gnu) 707if (_format is not TarEntryFormat.Pax) 725if (_format is not TarEntryFormat.Pax) 1070if (isOctalRange || _format == TarEntryFormat.Pax) 1074else if (_format == TarEntryFormat.Gnu) 1096if (isOctalRange || _format == TarEntryFormat.Pax) 1100else if (_format == TarEntryFormat.Gnu)
System\Formats\Tar\TarHelpers.cs (8)
200internal static TarEntryType GetCorrectTypeFlagForFormat(TarEntryFormat format, TarEntryType entryType) 202if (format is TarEntryFormat.V7) 332internal static void ThrowIfEntryTypeNotSupported(TarEntryType entryType, TarEntryFormat archiveFormat, [CallerArgumentExpression(nameof(entryType))] string? paramName = null) 336case TarEntryFormat.V7: 347case TarEntryFormat.Ustar: 361case TarEntryFormat.Pax: 379case TarEntryFormat.Gnu: 404case TarEntryFormat.Unknown:
System\Formats\Tar\TarReader.cs (23)
111/// <para>More than one Global Extended Attributes Entry was found in the current <see cref="TarEntryFormat.Pax"/> archive.</para> 113/// <para>Two or more Extended Attributes entries were found consecutively in the current <see cref="TarEntryFormat.Pax"/> archive.</para></exception> 138TarEntryFormat.Pax => header._typeFlag is TarEntryType.GlobalExtendedAttributes ? 140TarEntryFormat.Gnu => new GnuTarEntry(header, this), 141TarEntryFormat.Ustar => new UstarTarEntry(header, this), 142TarEntryFormat.V7 or TarEntryFormat.Unknown or _ => new V7TarEntry(header, this), 171/// <para>More than one Global Extended Attributes Entry was found in the current <see cref="TarEntryFormat.Pax"/> archive.</para> 173/// <para>Two or more Extended Attributes entries were found consecutively in the current <see cref="TarEntryFormat.Pax"/> archive.</para></exception> 291TarEntryFormat.Pax => header._typeFlag is TarEntryType.GlobalExtendedAttributes ? 293TarEntryFormat.Gnu => new GnuTarEntry(header, this), 294TarEntryFormat.Ustar => new UstarTarEntry(header, this), 295TarEntryFormat.V7 or TarEntryFormat.Unknown or _ => new V7TarEntry(header, this), 321TarHeader? header = TarHeader.TryGetNextHeader(_archiveStream, copyData, TarEntryFormat.Unknown, processDataBlock: true); 363TarHeader? header = await TarHeader.TryGetNextHeaderAsync(_archiveStream, copyData, TarEntryFormat.Unknown, processDataBlock: true, cancellationToken).ConfigureAwait(false); 401actualHeader = TarHeader.TryGetNextHeader(_archiveStream, copyData, TarEntryFormat.Pax, processDataBlock: false); 434TarHeader? actualHeader = await TarHeader.TryGetNextHeaderAsync(_archiveStream, copyData, TarEntryFormat.Pax, processDataBlock: false, cancellationToken).ConfigureAwait(false); 468finalHeader = new(TarEntryFormat.Gnu); 470TarHeader? secondHeader = TarHeader.TryGetNextHeader(_archiveStream, copyData, TarEntryFormat.Gnu, processDataBlock: true); 488TarHeader? thirdHeader = TarHeader.TryGetNextHeader(_archiveStream, copyData, TarEntryFormat.Gnu, processDataBlock: true); 547TarHeader? secondHeader = await TarHeader.TryGetNextHeaderAsync(_archiveStream, copyData, TarEntryFormat.Gnu, processDataBlock: true, cancellationToken).ConfigureAwait(false); 566TarHeader? thirdHeader = await TarHeader.TryGetNextHeaderAsync(_archiveStream, copyData, TarEntryFormat.Gnu, processDataBlock: true, cancellationToken).ConfigureAwait(false);
System\Formats\Tar\TarWriter.cs (32)
27/// <remarks>When using this constructor, <see cref="TarEntryFormat.Pax"/> is used as the default format of the entries written to the archive using the <see cref="WriteEntry(string, string?)"/> method.</remarks> 31: this(archiveStream, TarEntryFormat.Pax, leaveOpen: false) 36/// Initializes a <see cref="TarWriter"/> instance that can write tar entries to the specified stream and optionally leaves the stream open upon disposal of this instance. When using this constructor, the format of the resulting archive is <see cref="TarEntryFormat.Pax"/>. 43: this(archiveStream, TarEntryFormat.Pax, leaveOpen) 52/// <param name="format">The format to use when calling <see cref="WriteEntry(string, string?)"/>. The default value is <see cref="TarEntryFormat.Pax"/>.</param> 55/// <remarks>The recommended format is <see cref="TarEntryFormat.Pax"/> for its flexibility.</remarks> 58/// <exception cref="ArgumentOutOfRangeException"><paramref name="format"/> is either <see cref="TarEntryFormat.Unknown"/>, or not one of the other enum values.</exception> 59public TarWriter(Stream archiveStream, TarEntryFormat format = TarEntryFormat.Pax, bool leaveOpen = false) 68if (format is not TarEntryFormat.V7 and not TarEntryFormat.Ustar and not TarEntryFormat.Pax and not TarEntryFormat.Gnu) 84public TarEntryFormat Format { get; } 194/// <para><see cref="TarEntryFormat.V7"/></para> 203/// <para><see cref="TarEntryFormat.Ustar"/>, <see cref="TarEntryFormat.Pax"/> and <see cref="TarEntryFormat.Gnu"/></para> 238/// <para><see cref="TarEntryFormat.V7"/></para> 247/// <para><see cref="TarEntryFormat.Ustar"/>, <see cref="TarEntryFormat.Pax"/> and <see cref="TarEntryFormat.Gnu"/></para> 286case TarEntryFormat.V7: 290case TarEntryFormat.Ustar: 294case TarEntryFormat.Pax: 305case TarEntryFormat.Gnu: 310Debug.Assert(entry.Format == TarEntryFormat.Unknown, "Missing format handler"); 328TarEntryFormat.V7 => entry._header.WriteAsV7Async(_archiveStream, buffer, cancellationToken), 329TarEntryFormat.Ustar => entry._header.WriteAsUstarAsync(_archiveStream, buffer, cancellationToken), 330TarEntryFormat.Pax when entry._header._typeFlag is TarEntryType.GlobalExtendedAttributes => entry._header.WriteAsPaxGlobalExtendedAttributesAsync(_archiveStream, buffer, _nextGlobalExtendedAttributesEntryNumber++, cancellationToken), 331TarEntryFormat.Pax => entry._header.WriteAsPaxAsync(_archiveStream, buffer, cancellationToken), 332TarEntryFormat.Gnu => entry._header.WriteAsGnuAsync(_archiveStream, buffer, cancellationToken),
System\Formats\Tar\TarWriter.Unix.cs (5)
36Interop.Sys.FileTypes.S_IFREG => Format is TarEntryFormat.V7 ? TarEntryType.V7RegularFile : TarEntryType.RegularFile, 45TarEntryFormat.V7 => new V7TarEntry(entryType, entryName), 46TarEntryFormat.Ustar => new UstarTarEntry(entryType, entryName), 47TarEntryFormat.Pax => new PaxTarEntry(entryType, entryName), 48TarEntryFormat.Gnu => new GnuTarEntry(entryType, entryName),
System\Formats\Tar\UstarTarEntry.cs (5)
13: base(header, readerOfOrigin, TarEntryFormat.Ustar) 33: base(entryType, entryName, TarEntryFormat.Ustar, isGea: false) 45: base(other, TarEntryFormat.Ustar) 47if (other._header._format is TarEntryFormat.Ustar or TarEntryFormat.Pax)
System\Formats\Tar\V7TarEntry.cs (3)
13: base(header, readerOfOrigin, TarEntryFormat.V7) 28: base(entryType, entryName, TarEntryFormat.V7, isGea: false) 39: base(other, TarEntryFormat.V7)