Struct AddrPolicy 

pub struct AddrPolicy {
    rules: Vec<AddrPolicyRule>,
}

A sequence of rules that are applied to an address:port until one matches.

Each rule is of the form “accept PATTERN” or “reject PATTERN”, where every pattern describes a set of addresses and ports. Address sets are given as a prefix of 0-128 bits that the address must have; port sets are given as a low-bound and high-bound that the target port might lie between.

Relays use this type for defining their own policies, and for publishing their IPv4 policies. Clients instead use super::portpolicy::PortPolicy objects to view a summary of the relays’ declared policies.

An example IPv4 policy might be:

 reject *:25
 reject 127.0.0.0/8:*
 reject 192.168.0.0/16:*
 accept *:80
 accept *:443
 accept *:9000-65535
 reject *:*

Fields

rules: Vec<AddrPolicyRule>

A list of rules to apply to find out whether an address is contained by this policy.

The rules apply in order; the first one to match determines whether the address is accepted or rejected.

Implementations

impl AddrPolicy

pub fn allows(&self, addr: &IpAddr, port: u16) -> Option<RuleKind>

Apply this policy to an address:port combination

We do this by applying each rule in sequence, until one matches.

Returns None if no rule matches.

pub fn allows_sockaddr(&self, addr: &SocketAddr) -> Option<RuleKind>

As allows, but accept a SocketAddr.

pub fn new() -> Self

Create a new AddrPolicy that matches nothing.

pub fn push(&mut self, kind: RuleKind, pattern: AddrPortPattern)

Add a new rule to this policy.

The newly added rule is applied after all previous rules. It matches all addresses and ports covered by AddrPortPattern.

If accept is true, the rule is to accept addresses that match; if accept is false, the rule rejects such addresses.

Trait Implementations

impl Clone for AddrPolicy

fn clone(&self) -> AddrPolicy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AddrPolicy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AddrPolicy

fn default() -> AddrPolicy

Returns the “default value” for a type.

impl NetdocParseableFields for AddrPolicy

type Accumulator = AddrPolicy

The partially-parsed set of items.

fn is_item_keyword(kw: KeywordRef<'_>) -> bool

Is this one of the keywords in this struct

fn accumulate_item( acc: &mut Self::Accumulator, item: UnparsedItem<'_>, ) -> Result<(), EP>

Accumulate an item in this struct

fn finish(acc: Self::Accumulator) -> Result<Self, EP>

Finish

impl PartialEq for AddrPolicy

fn eq(&self, other: &AddrPolicy) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for AddrPolicy

impl StructuralPartialEq for AddrPolicy