Class UnixFileSystem

A backend that uses Posix(?) API calls to access the file system.

Inheritance
Object
UnixFileSystem
Implements
Inherited Members
Namespace: FubarDev.FtpServer.FileSystem.Unix
Assembly: FubarDev.FtpServer.FileSystem.Unix.dll
Syntax
public class UnixFileSystem : IUnixFileSystem

Constructors

| Improve this Doc View Source

UnixFileSystem(IUnixDirectoryEntry, IFtpUser, Nullable<UnixUserInfo>)

Initializes a new instance of the UnixFileSystem class.

Declaration
[Obsolete("Use the overload with ClaimsPrincipal.")]
public UnixFileSystem(IUnixDirectoryEntry root, IFtpUser user, UnixUserInfo? userInfo)
Parameters
Type Name Description
IUnixDirectoryEntry root

The root directory.
IFtpUser user

The current user.
Nullable<Mono.Unix.UnixUserInfo> userInfo

The user information.
| Improve this Doc View Source

UnixFileSystem(IUnixDirectoryEntry, ClaimsPrincipal, Nullable<UnixUserInfo>)

Initializes a new instance of the UnixFileSystem class.

Declaration
public UnixFileSystem(IUnixDirectoryEntry root, ClaimsPrincipal user, UnixUserInfo? userInfo)
Parameters
Type Name Description
IUnixDirectoryEntry root

The root directory.
ClaimsPrincipal user

The current user.
Nullable<Mono.Unix.UnixUserInfo> userInfo

The user information.

Properties

| Improve this Doc View Source

FileSystemEntryComparer

Declaration
public StringComparer FileSystemEntryComparer { get; }
Property Value
Type Description
StringComparer
| Improve this Doc View Source

Root

Declaration
public IUnixDirectoryEntry Root { get; }
Property Value
Type Description
IUnixDirectoryEntry
| Improve this Doc View Source

SupportsAppend

Declaration
public bool SupportsAppend { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

SupportsNonEmptyDirectoryDelete

Declaration
public bool SupportsNonEmptyDirectoryDelete { get; }
Property Value
Type Description
Boolean

Methods

| Improve this Doc View Source

AppendAsync(IUnixFileEntry, Nullable<Int64>, Stream, CancellationToken)

Declaration
public Task<IBackgroundTransfer? > AppendAsync(IUnixFileEntry fileEntry, long? startPosition, Stream data, CancellationToken cancellationToken)
Parameters
Type Name Description
IUnixFileEntry fileEntry
Nullable<Int64> startPosition
Stream data
CancellationToken cancellationToken
Returns
Type Description
Task<Nullable<IBackgroundTransfer>>
| Improve this Doc View Source

CreateAsync(IUnixDirectoryEntry, String, Stream, CancellationToken)

Declaration
public Task<IBackgroundTransfer? > CreateAsync(IUnixDirectoryEntry targetDirectory, string fileName, Stream data, CancellationToken cancellationToken)
Parameters
Type Name Description
IUnixDirectoryEntry targetDirectory
String fileName
Stream data
CancellationToken cancellationToken
Returns
Type Description
Task<Nullable<IBackgroundTransfer>>
| Improve this Doc View Source

CreateDirectoryAsync(IUnixDirectoryEntry, String, CancellationToken)

Declaration
public Task<IUnixDirectoryEntry> CreateDirectoryAsync(IUnixDirectoryEntry targetDirectory, string directoryName, CancellationToken cancellationToken)
Parameters
Type Name Description
IUnixDirectoryEntry targetDirectory
String directoryName
CancellationToken cancellationToken
Returns
Type Description
Task<IUnixDirectoryEntry>
| Improve this Doc View Source

GetEntriesAsync(IUnixDirectoryEntry, CancellationToken)

Declaration
public Task<IReadOnlyList<IUnixFileSystemEntry>> GetEntriesAsync(IUnixDirectoryEntry directoryEntry, CancellationToken cancellationToken)
Parameters
Type Name Description
IUnixDirectoryEntry directoryEntry
CancellationToken cancellationToken
Returns
Type Description
Task<IReadOnlyList<IUnixFileSystemEntry>>
| Improve this Doc View Source

GetEntryByNameAsync(IUnixDirectoryEntry, String, CancellationToken)

Declaration
public Task<IUnixFileSystemEntry? > GetEntryByNameAsync(IUnixDirectoryEntry directoryEntry, string name, CancellationToken cancellationToken)
Parameters
Type Name Description
IUnixDirectoryEntry directoryEntry
String name
CancellationToken cancellationToken
Returns
Type Description
Task<Nullable<IUnixFileSystemEntry>>
| Improve this Doc View Source

MoveAsync(IUnixDirectoryEntry, IUnixFileSystemEntry, IUnixDirectoryEntry, String, CancellationToken)

Declaration
public Task<IUnixFileSystemEntry> MoveAsync(IUnixDirectoryEntry parent, IUnixFileSystemEntry source, IUnixDirectoryEntry target, string fileName, CancellationToken cancellationToken)
Parameters
Type Name Description
IUnixDirectoryEntry parent
IUnixFileSystemEntry source
IUnixDirectoryEntry target
String fileName
CancellationToken cancellationToken
Returns
Type Description
Task<IUnixFileSystemEntry>
| Improve this Doc View Source

OpenReadAsync(IUnixFileEntry, Int64, CancellationToken)

Declaration
public Task<Stream> OpenReadAsync(IUnixFileEntry fileEntry, long startPosition, CancellationToken cancellationToken)
Parameters
Type Name Description
IUnixFileEntry fileEntry
Int64 startPosition
CancellationToken cancellationToken
Returns
Type Description
Task<Stream>
| Improve this Doc View Source

ReplaceAsync(IUnixFileEntry, Stream, CancellationToken)

Declaration
public Task<IBackgroundTransfer? > ReplaceAsync(IUnixFileEntry fileEntry, Stream data, CancellationToken cancellationToken)
Parameters
Type Name Description
IUnixFileEntry fileEntry
Stream data
CancellationToken cancellationToken
Returns
Type Description
Task<Nullable<IBackgroundTransfer>>
| Improve this Doc View Source

SetMacTimeAsync(IUnixFileSystemEntry, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, CancellationToken)

Declaration
public Task<IUnixFileSystemEntry> SetMacTimeAsync(IUnixFileSystemEntry entry, DateTimeOffset? modify, DateTimeOffset? access, DateTimeOffset? create, CancellationToken cancellationToken)
Parameters
Type Name Description
IUnixFileSystemEntry entry
Nullable<DateTimeOffset> modify
Nullable<DateTimeOffset> access
Nullable<DateTimeOffset> create
CancellationToken cancellationToken
Returns
Type Description
Task<IUnixFileSystemEntry>
| Improve this Doc View Source

UnlinkAsync(IUnixFileSystemEntry, CancellationToken)

Declaration
public Task UnlinkAsync(IUnixFileSystemEntry entry, CancellationToken cancellationToken)
Parameters
Type Name Description
IUnixFileSystemEntry entry
CancellationToken cancellationToken
Returns
Type Description
Task

Implements