Class SerializableFile

Inheritance
object
SerializableFileInfo
SerializableFile
FineTuningFile
File<T>
Implements
Inherited Members
Namespace: Glitch9.IO.Files
Assembly: Glitch9.IO.dll
Syntax
[Serializable]
[JsonConverter(typeof(IFileJsonConverter))]
public class SerializableFile : SerializableFileInfo, ISerializable, IFile, IData, IHasId<string>, IHasName

Constructors

| Edit this page View Source

SerializableFile()

Declaration
public SerializableFile()
| Edit this page View Source

SerializableFile(FileInfo, string, ReadOnlyMemory<byte>?, SerializableMetadata)

Declaration
public SerializableFile(FileInfo fileInfo, string cloudUrl = null, ReadOnlyMemory<byte>? data = null, SerializableMetadata metadata = null)
Parameters
Type Name Description
FileInfo fileInfo
string cloudUrl
ReadOnlyMemory<byte>? data
SerializableMetadata metadata
| Edit this page View Source

SerializableFile(string, string, ReadOnlyMemory<byte>?, SerializableMetadata)

Declaration
public SerializableFile(string fullPath, string cloudUrl = null, ReadOnlyMemory<byte>? data = null, SerializableMetadata metadata = null)
Parameters
Type Name Description
string fullPath
string cloudUrl
ReadOnlyMemory<byte>? data
SerializableMetadata metadata

Fields

| Edit this page View Source

data

Declaration
protected ReadOnlyMemory<byte> data
Field Value
Type Description
ReadOnlyMemory<byte>
| Edit this page View Source

k_DelayBeforeCancelLoad

Declaration
protected const int k_DelayBeforeCancelLoad = 500
Field Value
Type Description
int

Properties

| Edit this page View Source

FileType

Declaration
public virtual string FileType { get; }
Property Value
Type Description
string
| Edit this page View Source

HasData

Declaration
public virtual bool HasData { get; }
Property Value
Type Description
bool
| Edit this page View Source

HasValidPath

Declaration
public virtual bool HasValidPath { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsLoaded

Declaration
public virtual bool IsLoaded { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsLoading

Declaration
public bool IsLoading { get; protected set; }
Property Value
Type Description
bool
| Edit this page View Source

LastError

Declaration
public string LastError { get; protected set; }
Property Value
Type Description
string

Methods

| Edit this page View Source

ChangeExtension(string)

Declaration
public void ChangeExtension(string newExtension)
Parameters
Type Name Description
string newExtension
| Edit this page View Source

EncodeToBase64()

Declaration
public string EncodeToBase64()
Returns
Type Description
string
| Edit this page View Source

EncodeToBase64Async()

Declaration
public UniTask<string> EncodeToBase64Async()
Returns
Type Description
UniTask<string>
| Edit this page View Source

EnsureAssetLoaded(Action<bool>)

Declaration
public virtual void EnsureAssetLoaded(Action<bool> onResult = null)
Parameters
Type Name Description
Action<bool> onResult
| Edit this page View Source

EnsureAssetLoadedAsync(Action<bool>)

Declaration
public virtual UniTask EnsureAssetLoadedAsync(Action<bool> onResult = null)
Parameters
Type Name Description
Action<bool> onResult
Returns
Type Description
UniTask
| Edit this page View Source

FromRelativePath(string, string, ReadOnlyMemory<byte>?, SerializableMetadata)

Declaration
public static SerializableFile FromRelativePath(string path, string cloudUrl = null, ReadOnlyMemory<byte>? data = null, SerializableMetadata metadata = null)
Parameters
Type Name Description
string path
string cloudUrl
ReadOnlyMemory<byte>? data
SerializableMetadata metadata
Returns
Type Description
SerializableFile
| Edit this page View Source

FromUnityObject(string, Object)

Declaration
public static SerializableFile FromUnityObject(string fullPath, Object asset)
Parameters
Type Name Description
string fullPath
Object asset
Returns
Type Description
SerializableFile
| Edit this page View Source

ReadAllBytes()

Declaration
public virtual byte[] ReadAllBytes()
Returns
Type Description
byte[]
| Edit this page View Source

ReadAllBytesAsync()

Declaration
public virtual UniTask<byte[]> ReadAllBytesAsync()
Returns
Type Description
UniTask<byte[]>
| Edit this page View Source

ReloadAsset(Action<bool>)

Declaration
public virtual void ReloadAsset(Action<bool> onResult = null)
Parameters
Type Name Description
Action<bool> onResult
| Edit this page View Source

WriteAllBytes(string, IBinarySource, string, SerializableMetadata)

Declaration
public static SerializableFile WriteAllBytes(string fullPath, IBinarySource binary, string cloudUrl = null, SerializableMetadata metadata = null)
Parameters
Type Name Description
string fullPath
IBinarySource binary
string cloudUrl
SerializableMetadata metadata
Returns
Type Description
SerializableFile
| Edit this page View Source

WriteAllBytesAsync(string, byte[], string, SerializableMetadata)

Declaration
public static UniTask<SerializableFile> WriteAllBytesAsync(string fullPath, byte[] bytes, string cloudUrl = null, SerializableMetadata metadata = null)
Parameters
Type Name Description
string fullPath
byte[] bytes
string cloudUrl
SerializableMetadata metadata
Returns
Type Description
UniTask<SerializableFile>
| Edit this page View Source

WriteSerializableFile(string, string)

Declaration
public static SerializableFile WriteSerializableFile(string filePath, string fileContent)
Parameters
Type Name Description
string filePath
string fileContent
Returns
Type Description
SerializableFile
| Edit this page View Source

WriteSerializableFileAsync(string, byte[])

Declaration
public static UniTask<SerializableFile> WriteSerializableFileAsync(string filePath, byte[] fileBytes)
Parameters
Type Name Description
string filePath
byte[] fileBytes
Returns
Type Description
UniTask<SerializableFile>
| Edit this page View Source

WriteSerializableFileAsync(string, string)

Declaration
public static UniTask<SerializableFile> WriteSerializableFileAsync(string filePath, string fileContent)
Parameters
Type Name Description
string filePath
string fileContent
Returns
Type Description
UniTask<SerializableFile>

Implements

Extension Methods