DnsFilterRuleSet Class

An aggregated collection of DNS filter rules from one or more parsed sources.

public sealed class DnsFilterRuleSet

Remarks

This type is not thread-safe for concurrent mutation. It is safe to hand a rule set to DnsFilterEngine and keep mutating it afterwards: the engine snapshots the rules when it builds.

Constructors

NameDescription
DnsFilterRuleSet()

DnsFilterRuleSet()

DnsFilterRuleSet.cs
public DnsFilterRuleSet()

No documentation is available.

Properties

NameDescription
CountGets the number of rules in this rule set.
RulesGets a snapshot of the rules in this rule set.

Gets the number of rules in this rule set.

public int Count { get; }

Property value

int

Gets a snapshot of the rules in this rule set.

public IReadOnlyList<DnsFilterRule> Rules { get; }

Methods

NameDescription
Add(DnsFilterRule)Adds a single rule to this rule set.
AddFromList(TextReader, DnsFilterListFormat)Adds rules parsed from a filter list.
AddFromList(string, DnsFilterListFormat)Adds rules parsed from a filter list string.
AddRange(IEnumerable<DnsFilterRule>)Adds multiple rules to this rule set.
Clear()Removes all rules from this rule set.

Add(DnsFilterRule)

DnsFilterRuleSet.cs

Adds a single rule to this rule set.

public void Add(DnsFilterRule rule)

Parameters

rule DnsFilterRule
The rule to add.

AddFromList overloads

AddFromList(TextReader, DnsFilterListFormat)

DnsFilterRuleSet.cs

Adds rules parsed from a filter list.

Parameters
reader TextReader
The text reader containing the filter list.
format DnsFilterListFormat
The format of the filter list.
Returns

IReadOnlyList<DnsFilterParseDiagnostic> A diagnostic for each line that did not produce a rule.

AddFromList(string, DnsFilterListFormat)

DnsFilterRuleSet.cs

Adds rules parsed from a filter list string.

Parameters
text string
The filter list text.
format DnsFilterListFormat
The format of the filter list.
Returns

IReadOnlyList<DnsFilterParseDiagnostic> A diagnostic for each line that did not produce a rule.

AddRange(IEnumerable<DnsFilterRule>)

DnsFilterRuleSet.cs

Adds multiple rules to this rule set.

public void AddRange(IEnumerable<DnsFilterRule> rules)

Parameters

rules IEnumerable<DnsFilterRule>
The rules to add.

Removes all rules from this rule set.

public void Clear()