Class FtpFolderRegexRule

Namespace

FluentFTP.Rules

Assembly

FluentFTP.dll

Only accept folders whose names match the given regular expression(s), or exclude folders that match.

public class FtpFolderRegexRule : FtpRule

Inheritance

object

FtpRule

FtpFolderRegexRule

Inherited Members

FtpRule.IsAllAllowed(List<FtpRule>, FtpListItem)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ValuePrinter.ObjectToString(object)

Constructors

FtpFolderRegexRule(bool, IList<string>, int)

Only accept items that one of the supplied regex pattern.

public FtpFolderRegexRule(bool whitelist, IList<string> regexPatterns, int startSegment = 0)

Parameters

whitelist bool

If true, only folders where one of the supplied regex pattern matches are uploaded or downloaded. If false, folders where one of the supplied regex pattern matches are excluded.

regexPatterns IList<string>

The list of regex patterns to match. Only valid patterns are accepted and stored. If none of the patterns are valid, this rule is disabled and passes all objects.

startSegment int

Which path segment to start checking from. 0 checks root folder onwards. 1 skips root folder.

Properties

RegexPatterns

The files names to match

public List<string> RegexPatterns { get; set; }

Property Value

List<string>

StartSegment

Which path segment to start checking from

public int StartSegment { get; set; }

Property Value

int

Whitelist

If true, only folders where one of the supplied regex pattern matches are uploaded or downloaded. If false, folders where one of the supplied regex pattern matches are excluded.

public bool Whitelist { get; set; }

Property Value

bool

Methods

IsAllowed(FtpListItem)

Checks if the FtpListItem Name does match any RegexPattern

public override bool IsAllowed(FtpListItem item)

Parameters

item FtpListItem

Returns

bool