FileSystemFile Members

NFX Class Library

[This is preliminary documentation and is subject to change.]

The FileSystemFile type exposes the following members.

Constructors

	Name	Description
	FileSystemFile	Internal method that should not be called by developers

Methods

	Name	Description
	CheckCanChange	Throws when item can not change (Inherited from FileSystemSessionItem.)
	CheckCanChangeAsync	Async version of CheckCanChange (Inherited from FileSystemSessionItem.)
	Delete	Deletes this item from file system (Inherited from FileSystemSessionItem.)
	DeleteAsync	Async version of Delete (Inherited from FileSystemSessionItem.)
	Destructor	(Overrides FileSystemSessionItem Destructor .)
	Dispose	Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead (Inherited from DisposableObject.)
	EnsureObjectNotDisposed	Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called (Inherited from DisposableObject.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	(Inherited from DisposableObject.)
	GetCreationUserAsync	Async version of [P:CreationUser] (Inherited from FileSystemSessionItem.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetLastAccessUserAsync	Async version of [P:LastAccessUser] (Inherited from FileSystemSessionItem.)
	GetModificationUserAsync	Async version of [P:ModificationUser] (Inherited from FileSystemSessionItem.)
	GetSizeAsync	Async version of [P:Size] (Inherited from FileSystemSessionItem.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReadAllText	Reads all text from file using byte order mark detection with UTF8 encoding
	ReadAllText(Encoding, Boolean, Int32)	Reads all text from stream using the specified parameters
	ReadAllTextAsync	Async version of ReadAllText
	ReadAllTextAsync(Encoding, Boolean, Int32)	Async version of ReadAllText(Encoding, Boolean, Int32)
	Refresh	Refreshes the state represented by this item, i.e. this may re-read attributes from remote file system (Inherited from FileSystemSessionItem.)
	RefreshAsync	Async version of Refresh (Inherited from FileSystemSessionItem.)
	Rename	Renames an item. Check file system capabilities to see if renaming is supported (Inherited from FileSystemSessionItem.)
	RenameAsync	Async version of Rename(String) (Inherited from FileSystemSessionItem.)
	SetCreationTimestampAsync	Async version of [P:CreationTimestamp] (Inherited from FileSystemSessionItem.)
	SetLastAccessTimestampAsync	Async version of [P:LastAccessTimestamp] (Inherited from FileSystemSessionItem.)
	SetModificationTimestampAsync	Async version of [P:ModificationTimestamp] (Inherited from FileSystemSessionItem.)
	SetReadOnlyAsync	Async version of [P:ReadOnly] (Inherited from FileSystemSessionItem.)
	ToString	(Inherited from FileSystemSessionItem.)
	WriteAllText(String)	Sets file content to supplied string using default UTF8 encoding
	WriteAllText(String, Encoding, Int32)	Sets file content to supplied string using the specified parameters
	WriteAllTextAsync(String)	Async version of WriteAllText(String)
	WriteAllTextAsync(String, Encoding, Int32)	Async version of WriteAllText(String, Encoding, Int32)

Extension Methods

	Name	Description
	AsBool	(Defined by ObjectValueConversion.)
	AsByte	(Defined by ObjectValueConversion.)
	AsChar	(Defined by ObjectValueConversion.)
	AsDateTime	Overloaded. (Defined by ObjectValueConversion.)
	AsDateTime(DateTime, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsDecimal	(Defined by ObjectValueConversion.)
	AsDouble	(Defined by ObjectValueConversion.)
	AsEnum TEnum	(Defined by ObjectValueConversion.)
	AsFloat	(Defined by ObjectValueConversion.)
	AsGDID	Overloaded. (Defined by ObjectValueConversion.)
	AsGDID(GDID, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGUID	(Defined by ObjectValueConversion.)
	AsInt	(Defined by ObjectValueConversion.)
	AsJSONConfig	(Defined by ObjectValueConversion.)
	AsLaconicConfig	(Defined by ObjectValueConversion.)
	AsLong	(Defined by ObjectValueConversion.)
	AsNonNullOrEmptyString	(Defined by ObjectValueConversion.)
	AsNullableBool	(Defined by ObjectValueConversion.)
	AsNullableByte	(Defined by ObjectValueConversion.)
	AsNullableChar	(Defined by ObjectValueConversion.)
	AsNullableDateTime	(Defined by ObjectValueConversion.)
	AsNullableDecimal	(Defined by ObjectValueConversion.)
	AsNullableDouble	(Defined by ObjectValueConversion.)
	AsNullableEnum TEnum	(Defined by ObjectValueConversion.)
	AsNullableFloat	(Defined by ObjectValueConversion.)
	AsNullableGDID	(Defined by ObjectValueConversion.)
	AsNullableGDIDSymbol	(Defined by ObjectValueConversion.)
	AsNullableGUID	(Defined by ObjectValueConversion.)
	AsNullableInt	(Defined by ObjectValueConversion.)
	AsNullableLong	(Defined by ObjectValueConversion.)
	AsNullableSByte	(Defined by ObjectValueConversion.)
	AsNullableShort	(Defined by ObjectValueConversion.)
	AsNullableTimeSpan	(Defined by ObjectValueConversion.)
	AsNullableUInt	(Defined by ObjectValueConversion.)
	AsNullableULong	(Defined by ObjectValueConversion.)
	AsNullableUShort	(Defined by ObjectValueConversion.)
	AsSByte	(Defined by ObjectValueConversion.)
	AsShort	(Defined by ObjectValueConversion.)
	AsString	(Defined by ObjectValueConversion.)
	AsTimeSpan	Overloaded. (Defined by ObjectValueConversion.)
	AsTimeSpan(TimeSpan, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsUInt	(Defined by ObjectValueConversion.)
	AsULong	(Defined by ObjectValueConversion.)
	AsUri	(Defined by ObjectValueConversion.)
	AsUShort	(Defined by ObjectValueConversion.)
	AsXMLConfig	(Defined by ObjectValueConversion.)
	ToErlObject	Overloaded. Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToErlObject(ErlTypeOrder, Boolean)	Overloaded. Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToJSON(JSONWritingOptions)	Overloaded. Serializes object into JSON string (Defined by JSONExtensions.)
	ToJSON(TextWriter, JSONWritingOptions)	Overloaded. Serializes object into JSON format using provided TextWriter (Defined by JSONExtensions.)
	ToJSON(Stream, JSONWritingOptions, Encoding)	Overloaded. Serializes object into JSON format using provided stream and optional encoding (Defined by JSONExtensions.)

Fields

	Name	Description
	m_FileSystem	(Inherited from FileSystemSessionItem.)
	m_Handle	(Inherited from FileSystemSessionItem.)
	m_Modified	(Inherited from FileSystemSessionItem.)
	m_Session	(Inherited from FileSystemSessionItem.)

Properties

	Name	Description
	CreationTimestamp	Gets/sets UTC creation timestamp (Inherited from FileSystemSessionItem.)
	CreationUser	Gets the user who created this item (Inherited from FileSystemSessionItem.)
	Disposed	Indicates whether this object was already disposed - the Dispose() has finished (Inherited from DisposableObject.)
	DisposeStarted	Indicates whether this object Dispose() has been called and dispose started but not finished yet (Inherited from DisposableObject.)
	FileStream	Returns a stream usable for file content access. If the file has not opened stream yet it will be opened and cached
	FileSystem	Returns filesystem - this is a shortcut to Session.FileSystem (Inherited from FileSystemSessionItem.)
	Handle	Returns file system handle for this entity (Inherited from FileSystemSessionItem.)
	IsReadOnly	Indicates whether this item can change and file system supports modifications (Inherited from FileSystemSessionItem.)
	LastAccessTimestamp	Gets/sets UTC last access timestamp (Inherited from FileSystemSessionItem.)
	LastAccessUser	Gets the last user who accessed the item (Inherited from FileSystemSessionItem.)
	MetadataStream	Returns item metadata stream (Inherited from FileSystemSessionItem.)
	ModificationTimestamp	Gets/sets UTC modification timestamp (Inherited from FileSystemSessionItem.)
	ModificationUser	Gets the user who modified this item (Inherited from FileSystemSessionItem.)
	Modified	Indicates whether anything has changed since last transaction has started (Inherited from FileSystemSessionItem.)
	Name	(Inherited from FileSystemSessionItem.)
	ParentPath	Returns path to directory that contains this item (Inherited from FileSystemSessionItem.)
	Path	Returns an absolute path for this item (Inherited from FileSystemSessionItem.)
	PermissionsStream	Returns item permissions stream (Inherited from FileSystemSessionItem.)
	ReadOnly	Gets/sets readonly attribute (Inherited from FileSystemSessionItem.)
	Session	Returns session through which this object was obtained (Inherited from FileSystemSessionItem.)
	Size	Returns the byte size of the item, depending on implementation this property may return approximate sizes for files and directories (i.e in distributed systems) (Inherited from FileSystemSessionItem.)