FileSurfer.Core.Models.FileTransferStream Class Reference

Defines a named stream used for file transfer. More...

Inheritance diagram for FileSurfer.Core.Models.FileTransferStream:

Collaboration diagram for FileSurfer.Core.Models.FileTransferStream:

Public Member Functions
	FileTransferStream (string name, Stream stream)
	Initializes a new instance of the FileTransferStream class.
void	Dispose ()

Static Public Member Functions
static ValueResult< FileTransferStream >	FromInfoProvider (IFileInfoProvider fileInfoProvider, string path)
	Creates a FileTransferStream from a file path using the provided file information provider.

Properties
Stream	Stream [get]
	Gets the file content stream.
string	Name [get]
	Gets the file name associated with Stream.

Detailed Description

Defines a named stream used for file transfer.

Constructor & Destructor Documentation

FileTransferStream()

FileSurfer.Core.Models.FileTransferStream.FileTransferStream ( string name, Stream stream )

inline

Initializes a new instance of the FileTransferStream class.

Parameters

name	File name associated with the transfer stream.
stream	Open stream containing file content.

Here is the caller graph for this function:

Member Function Documentation

Dispose()

void FileSurfer.Core.Models.FileTransferStream.Dispose ( )

inline

Here is the caller graph for this function:

FromInfoProvider()

ValueResult< FileTransferStream > FileSurfer.Core.Models.FileTransferStream.FromInfoProvider ( IFileInfoProvider fileInfoProvider, string path )

inlinestatic

Creates a FileTransferStream from a file path using the provided file information provider.

Parameters

fileInfoProvider	File information provider used to open the file stream and resolve its name.
path	Absolute or provider-relative path to the file.

Returns

A successful result with a transfer stream when the file can be opened; otherwise an error result.

Here is the call graph for this function:

Property Documentation

Name

string FileSurfer.Core.Models.FileTransferStream.Name

get

Gets the file name associated with Stream.

Stream

Stream FileSurfer.Core.Models.FileTransferStream.Stream

get

Gets the file content stream.

---

The documentation for this class was generated from the following file:

• /home/janecea/Documents/CODE/PROJECTS/FileSurfer/src/FileSurfer.Core/Models/TransferStream.cs