Interface IReadOnlyFile

Represents a read only view over a file contained within an IDirectory that could have metadata potentially attached to it by a unique System.Guid that tracks the file within the file system, as long as the Snowflake.Filesystem API methods are used.

Prefer using the IReadOnlyFile interface if no writes are guaranteed.

Namespace: Snowflake.Filesystem
Assembly: Snowflake.Framework.Primitives.dll
Syntax
public interface IReadOnlyFile

Properties

Created

Whether or not this file has been created or currently exists.

Keep in mind that does not actually create a file on the file system.

Declaration
bool Created { get; }
Property Value
Type Description
System.Boolean

FileGuid

The unique ID identifying this file in the directory manifest.

Declaration
Guid FileGuid { get; }
Property Value
Type Description
System.Guid

Whether or not this file is a link.

Declaration
bool IsLink { get; }
Property Value
Type Description
System.Boolean

Length

The length of the file in bytes. If the file does not yet exist, this value is -1.

Declaration
long Length { get; }
Property Value
Type Description
System.Int64

Name

The name of the file.

Declaration
string Name { get; }
Property Value
Type Description
System.String

ParentDirectory

The IDirectory under which this file is located.

Declaration
IReadOnlyDirectory ParentDirectory { get; }
Property Value
Type Description
IReadOnlyDirectory

RootedPath

The path of this file, relative to the root of the directory provider.

Declaration
string RootedPath { get; }
Property Value
Type Description
System.String

Methods

OpenReadStream()

Opens a read-only stream to the file. If it does not currently exist, System.IO.FileNotFoundException will be thrown.

Declaration
Stream OpenReadStream()
Returns
Type Description
System.IO.Stream

A read-write stream to the file.

UnsafeGetFilePath()

Returns the real file path of this file.

This method is obsolete because it is unsafe to use, without going through the interface methods of IFile, there is no guarantee that the parent IDirectory instance will remain consistent.

However, access to the underlying filesystem is necessary for the API to be remotely useful at the barrier.

If IsLink is true, then this returns the path that is linked to.

Restrict usage to read-only unless absolutely necessary.

Declaration
[Obsolete("Avoid accessing the underlying file path, and use the object methods instead.")]
FileInfo UnsafeGetFilePath()
Returns
Type Description
System.IO.FileInfo

The real file path of the file.

Extension Methods