Skip to content

DiGi.Core.IO.Classes

github-actions[bot] edited this page Jul 15, 2026 · 3 revisions

DiGi.Core.IO.Classes Namespace

Classes

Archive<TSerializableObject> Class

Represents an archive container for storing serialized data.

public class Archive<TSerializableObject> : DiGi.Core.Classes.SerializableObject, DiGi.Core.IO.Interfaces.IArchive, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject, DiGi.Core.IO.Interfaces.IIOObject
    where TSerializableObject : DiGi.Core.Interfaces.ISerializableObject

Type parameters

TSerializableObject

The type of object that can be serialized within the archive.

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObject → Archive<TSerializableObject>

Implements DiGi.Core.IO.Interfaces.IArchive, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject, DiGi.Core.IO.Interfaces.IIOObject

Constructors

Archive(byte[]) Constructor

Initializes a new instance of the Archive<TSerializableObject> class using the specified byte array.

public Archive(byte[] bytes);

Parameters

bytes System.Byte[]

The byte array to use for initialization.

Archive(Archive<TSerializableObject>) Constructor

Initializes a new instance of the Archive<TSerializableObject> class by copying an existing generic archive.

public Archive(DiGi.Core.IO.Classes.Archive<TSerializableObject> archive);

Parameters

archive DiGi.Core.IO.Classes.Archive<TSerializableObject>

The generic archive to copy from.

Archive(JsonObject) Constructor

Initializes a new instance of the Archive<TSerializableObject> class using the specified JSON object.

public Archive(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object to use for initialization.

Properties

Archive<TSerializableObject>.Bytes Property

Gets or sets the raw bytes contained within the archive.

public byte[]? Bytes { get; }

Implements Bytes

Property Value

System.Byte[]

FileFilter Class

Provides a filter for selecting files based on a name and a set of extensions.

public sealed class FileFilter : DiGi.Core.Classes.SerializableObject, DiGi.Core.IO.Interfaces.IIOObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObject → FileFilter

Implements DiGi.Core.IO.Interfaces.IIOObject, DiGi.Core.Interfaces.IObject

Constructors

FileFilter(FileFilter) Constructor

Initializes a new instance of the FileFilter class by copying an existing filter.

public FileFilter(DiGi.Core.IO.Classes.FileFilter? fileFilter);

Parameters

fileFilter FileFilter

The existing filter to copy.

FileFilter(string, IEnumerable<string>) Constructor

Initializes a new instance of the FileFilter class with a specified name and extensions.

public FileFilter(string? name, System.Collections.Generic.IEnumerable<string>? extensions);

Parameters

name System.String

The name of the filter.

extensions System.Collections.Generic.IEnumerable<System.String>

The collection of file extensions associated with the filter.

FileFilter(JsonObject) Constructor

Initializes a new instance of the FileFilter class using the specified JSON object.

public FileFilter(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object to use for initialization.

Properties

FileFilter.Extensions Property

Gets or sets the list of file extensions associated with this filter.

public System.Collections.Generic.List<string>? Extensions { get; }

Property Value

System.Collections.Generic.List<System.String>

FileFilter.Name Property

Gets or sets the descriptive name of the file filter.

public string? Name { get; }

Property Value

System.String

Methods

FileFilter.Clone() Method

Creates a copy of the current object.

public override DiGi.Core.Interfaces.ISerializableObject? Clone();

Implements Clone()

Returns

DiGi.Core.Interfaces.ISerializableObject
A new instance of the current object containing a copy of its data.

FileFilter.Equals(object) Method

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj);

Parameters

obj System.Object

The object to compare with the current object.

Returns

System.Boolean
True if the specified object is equal to the current object; otherwise, false.

FileFilter.GetHashCode() Method

Returns the hash code for the current object.

public override int GetHashCode();

Returns

System.Int32
The hash code for the current object.

FileFilter.ToString() Method

Returns a string that represents the current object.

public override string ToString();

Returns

System.String
A string representation of the current object.

Report Class

Represents a report used for collecting and exporting data.

public sealed class Report : DiGi.Core.IO.Interfaces.IIOObject, DiGi.Core.Interfaces.IObject

Inheritance System.Object → Report

Implements DiGi.Core.IO.Interfaces.IIOObject, DiGi.Core.Interfaces.IObject

Constructors

Report() Constructor

Initializes a new instance of the Report class.

public Report();

Report(char) Constructor

Initializes a new instance of the Report class with a specified separator character.

public Report(char separator);

Parameters

separator System.Char

The character used to separate values in the report.

Methods

Report.Add() Method

Adds a new entry to the report.

public void Add();

Report.Add(object[]) Method

Adds one or more objects to the report.

public void Add(params object?[]? values);

Parameters

values System.Object[]

The objects to add to the report.

Report.Add<T>(IEnumerable<T>) Method

Adds a collection of values to the report.

public void Add<T>(System.Collections.Generic.IEnumerable<T?>? values);

Type parameters

T

The type of elements in the collection.

Parameters

values System.Collections.Generic.IEnumerable<T>

The collection of values to add to the report.

Report.Add<T>(T[]) Method

Adds one or more values of type T to the report.

public void Add<T>(params T?[]? values);

Type parameters

T

The type of values to add.

Parameters

values T[]

The values of type T to add to the report.

Report.GetHashCode() Method

Returns the hash code for this instance.

public override int GetHashCode();

Returns

System.Int32
The hash code for this instance.

Report.ToString() Method

Returns a string representation of the current report.

public override string ToString();

Returns

System.String
A string that represents the current report.

Report.Write(string) Method

Writes the report content to the specified file path.

public bool Write(string? path);

Parameters

path System.String

The path where the report will be written.

Returns

System.Boolean
True if the write operation was successful; otherwise, false.

Clone this wiki locally