Interface IArchiveInfo

Namespace

Cobilas.GodotEngine.Utility.IO.Interfaces

Assembly

com.cobilas.godot.utility.dll

Represents information about an archive file and provides operations for working with archive contents.

public interface IArchiveInfo : IDataInfo, IDisposable, IFormattable

Inherited Members

IDataInfo.Name

IDataInfo.FullName

IDataInfo.Attributes

IDataInfo.Parent

IDataInfo.IsInternal

IDataInfo.IsGodotRoot

IDataInfo.GetCreationTime

IDataInfo.GetCreationTimeUtc

IDataInfo.GetLastAccessTime

IDataInfo.GetLastAccessTimeUtc

IDataInfo.GetLastWriteTime

IDataInfo.GetLastWriteTimeUtc

IDisposable.Dispose()

IFormattable.ToString(string, IFormatProvider)

Remarks

This interface extends IDataInfo to provide archive-specific functionality including file extension information and stream-based access to archive contents.

Properties

ArchiveExtension

Gets the file extension of the archive.

string ArchiveExtension { get; }

Property Value

string

The archive file extension including the dot (e.g., ".zip", ".rar").

NameWithoutExtension

Gets the name of the archive without the file extension.

string NameWithoutExtension { get; }

Property Value

string

The archive name excluding the extension.

Methods

CopyTo(string?)

Copies the archive to the specified destination path without overwriting existing files.

bool CopyTo(string? destinationPath)

Parameters

destinationPath string

The destination path where the archive will be copied.

Returns

bool

true if the copy operation succeeded; otherwise, false.

CopyTo(string?, bool)

Copies the archive to the specified destination path.

bool CopyTo(string? destinationPath, bool overwrite)

Parameters

destinationPath string

The destination path where the archive will be copied.

overwrite bool

Whether to overwrite an existing file at the destination path.

Returns

bool

true if the copy operation succeeded; otherwise, false.

Move(string?)

Moves the archive to the specified destination path.

bool Move(string? destinationPath)

Parameters

destinationPath string

The destination path where the archive will be moved.

Returns

bool

true if the move operation succeeded; otherwise, false.

Open(FileAccess)

Opens the archive with the specified access mode using the default StreamType.

IStream Open(FileAccess access)

Parameters

access FileAccess

The file access mode specifying read and/or write permissions.

Returns

IStream

A stream object for reading from or writing to the archive.

Open(FileAccess, StreamType)

Opens the archive with the specified access mode and StreamType.

IStream Open(FileAccess access, StreamType type)

Parameters

access FileAccess

The file access mode specifying read and/or write permissions.

type StreamType

The type of stream to use for accessing the archive contents.

Returns

IStream

A stream object for reading from or writing to the archive.