LocalFileSystemStream MembersNFX Class Library

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

The LocalFileSystemStream type exposes the following members.
Constructors

  NameDescription
Public methodLocalFileSystemStream
Initializes a new instance of the LocalFileSystemStream class
Back to Top
Methods

  NameDescription
Public methodOnlineBeginRead
Begins an asynchronous read operation. (Consider using ReadAsync( Byte , Int32, Int32) instead; see the Remarks section.)
(Inherited from OnlineStream.)
Public methodOnlineBeginWrite
Begins an asynchronous write operation. (Consider using WriteAsync( Byte , Int32, Int32) instead; see the Remarks section.)
(Inherited from OnlineStream.)
Public methodOnlineClose
Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed.
(Inherited from OnlineStream.)
Public methodOnlineCopyTo(Stream)
Reads the bytes from the current stream and writes them to another stream.
(Inherited from OnlineStream.)
Public methodOnlineCopyTo(Stream, Int32)
Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.
(Inherited from OnlineStream.)
Public methodCopyToAsync(Stream)
Asynchronously reads the bytes from the current stream and writes them to another stream.
(Inherited from OnlineStream.)
Public methodCopyToAsync(Stream, Int32)
Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.
(Inherited from OnlineStream.)
Public methodCopyToAsync(Stream, Int32, CancellationToken)
Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.
(Inherited from OnlineStream.)
Public methodOnlineCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from OnlineMarshalByRefObject.)
Protected methodOnlineCreateWaitHandleObsolete.
Allocates a OnlineWaitHandle object.
(Inherited from OnlineStream.)
Public methodOnlineDispose 
Releases all resources used by the OnlineStream.
(Inherited from OnlineStream.)
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the LocalFileSystemStream and optionally releases the managed resources
(Overrides FileSystemStream Dispose(Boolean).)
Protected methodDoFlush (Overrides FileSystemStream DoFlush .)
Protected methodDoGetLength (Overrides FileSystemStream DoGetLength .)
Protected methodDoGetPosition (Overrides FileSystemStream DoGetPosition .)
Protected methodDoRead (Overrides FileSystemStream DoRead( Byte , Int32, Int32).)
Protected methodDoSeek (Overrides FileSystemStream DoSeek(Int64, SeekOrigin).)
Protected methodDoSetLength (Overrides FileSystemStream DoSetLength(Int64).)
Protected methodDoSetPosition (Overrides FileSystemStream DoSetPosition(Int64).)
Protected methodDoWrite (Overrides FileSystemStream DoWrite( Byte , Int32, Int32).)
Public methodOnlineEndRead
Waits for the pending asynchronous read to complete. (Consider using ReadAsync( Byte , Int32, Int32) instead; see the Remarks section.)
(Inherited from OnlineStream.)
Public methodOnlineEndWrite
Ends an asynchronous write operation. (Consider using WriteAsync( Byte , Int32, Int32) instead; see the Remarks section.)
(Inherited from OnlineStream.)
Public methodOnlineEquals
Determines whether the specified object is equal to the current object.
(Inherited from OnlineObject.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodFlush (Inherited from FileSystemStream.)
Public methodFlushAsync 
Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.
(Inherited from OnlineStream.)
Public methodFlushAsync(CancellationToken) (Inherited from FileSystemStream.)
Public methodOnlineGetHashCode
Serves as the default hash function.
(Inherited from OnlineObject.)
Public methodOnlineGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from OnlineMarshalByRefObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodOnlineInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from OnlineMarshalByRefObject.)
Protected methodOnlineMemberwiseClone 
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineMemberwiseClone(Boolean)
Creates a shallow copy of the current OnlineMarshalByRefObject object.
(Inherited from OnlineMarshalByRefObject.)
Protected methodOnlineObjectInvariantObsolete.
Provides support for a Contract.
(Inherited from OnlineStream.)
Public methodRead (Inherited from FileSystemStream.)
Public methodReadAsync( Byte , Int32, Int32)
Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
(Inherited from OnlineStream.)
Public methodReadAsync( Byte , Int32, Int32, CancellationToken) (Inherited from FileSystemStream.)
Public methodOnlineReadByte
Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
(Inherited from OnlineStream.)
Public methodSeek (Inherited from FileSystemStream.)
Public methodSetLength (Inherited from FileSystemStream.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Public methodWrite (Inherited from FileSystemStream.)
Public methodWriteAsync( Byte , Int32, Int32)
Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
(Inherited from OnlineStream.)
Public methodWriteAsync( Byte , Int32, Int32, CancellationToken) (Inherited from FileSystemStream.)
Public methodOnlineWriteByte
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
(Inherited from OnlineStream.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsBool (Defined by ObjectValueConversion.)
Public Extension MethodAsByte (Defined by ObjectValueConversion.)
Public Extension MethodAsChar (Defined by ObjectValueConversion.)
Public Extension MethodAsCharEnumerable (Defined by IOMiscUtils.)
Public Extension MethodAsDateTime Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime(DateTime, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID(GDID, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsInt (Defined by ObjectValueConversion.)
Public Extension MethodAsJSONConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLaconicConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNonNullOrEmptyString (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableBool (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableChar (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDateTime (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDIDSymbol (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableShort (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableTimeSpan (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableULong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsShort (Defined by ObjectValueConversion.)
Public Extension MethodAsString (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan(TimeSpan, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsULong (Defined by ObjectValueConversion.)
Public Extension MethodAsUri (Defined by ObjectValueConversion.)
Public Extension MethodAsUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsXMLConfig (Defined by ObjectValueConversion.)
Public Extension MethodJSONToDataObject
Deserializes JSON content into IJSONDataObject
(Defined by JSONExtensions.)
Public Extension MethodJSONToDynamic
Deserializes JSON content into dynamic JSON object
(Defined by JSONExtensions.)
Public Extension MethodReadBEInt32
Reads an integer encoded as big endian from buffer at the specified index
(Defined by IOMiscUtils.)
Public Extension MethodReadBEShort
Reads a short encoded as big endian from stream
(Defined by IOMiscUtils.)
Public Extension MethodReadBEUInt64
Reads an integer encoded as big endian from buffer at the specified index
(Defined by IOMiscUtils.)
Public Extension MethodReadBEUShort
Reads an ushort encoded as big endian from stream
(Defined by IOMiscUtils.)
Public Extension MethodReadSLEB128 Overloaded. (Defined by LEB128.)
Public Extension MethodReadSLEB128(Int32 )Overloaded. (Defined by LEB128.)
Public Extension MethodReadULEB128 Overloaded. (Defined by LEB128.)
Public Extension MethodReadULEB128(Int32 )Overloaded. (Defined by LEB128.)
Public Extension MethodToErlObject Overloaded.
Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToErlObject(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.)
Public Extension MethodToJSON(JSONWritingOptions)Overloaded.
Serializes object into JSON string
(Defined by JSONExtensions.)
Public Extension MethodToJSON(TextWriter, JSONWritingOptions)Overloaded.
Serializes object into JSON format using provided TextWriter
(Defined by JSONExtensions.)
Public Extension MethodToJSON(Stream, JSONWritingOptions, Encoding)Overloaded.
Serializes object into JSON format using provided stream and optional encoding
(Defined by JSONExtensions.)
Public Extension MethodWriteBEInt32
Writes an integer encoded as big endian to the given stream
(Defined by IOMiscUtils.)
Public Extension MethodWriteBEShort
Writes a short encoded as big endian to the given stream
(Defined by IOMiscUtils.)
Public Extension MethodWriteBEUInt64
Writes an unsigned long integer encoded as big endian to the given stream
(Defined by IOMiscUtils.)
Public Extension MethodWriteBEUShort
Writes an ushort encoded as big endian to the given stream
(Defined by IOMiscUtils.)
Public Extension MethodWriteSLEB128(Int64, Int32)Overloaded. (Defined by LEB128.)
Public Extension MethodWriteSLEB128(Int64, Int32 , Int32)Overloaded. (Defined by LEB128.)
Public Extension MethodWriteULEB128(UInt64, UInt32)Overloaded. (Defined by LEB128.)
Public Extension MethodWriteULEB128(UInt64, Int32 , UInt32)Overloaded. (Defined by LEB128.)
Back to Top
Fields

  NameDescription
Public fieldItem
Item that this stream is for
(Inherited from FileSystemStream.)
Back to Top
Properties

  NameDescription
Public propertyCanRead (Inherited from FileSystemStream.)
Public propertyCanSeek (Inherited from FileSystemStream.)
Public propertyOnlineCanTimeout
Gets a value that determines whether the current stream can time out.
(Inherited from OnlineStream.)
Public propertyCanWrite (Inherited from FileSystemStream.)
Public propertyLength (Inherited from FileSystemStream.)
Public propertyPosition (Inherited from FileSystemStream.)
Public propertyOnlineReadTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from OnlineStream.)
Public propertyOnlineWriteTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from OnlineStream.)
Back to Top
See Also