Struct PortPolicy 

pub struct PortPolicy {
    allowed: PortRanges,
}

A policy to match zero or more TCP/UDP ports.

These are used in Tor to summarize all policies in microdescriptors, and Ipv6 policies in router descriptors.

NOTE: If a port is listed as accepted, it doesn’t mean that the relay allows every address on that port. Instead, a port is listed if a relay will exit to most public addresses on that port. Therefore, unlike super::addrpolicy::AddrPolicy objects, these policies cannot tell you if a port is definitely allowed or rejected: only if it is probably allowed or rejected.

Examples

use tor_netdoc::types::policy::PortPolicy;
let policy: PortPolicy = "accept 1-1023,8000-8999,60000-65535".parse().unwrap();

assert!(policy.allows_port(22));
assert!(policy.allows_port(8000));
assert!(! policy.allows_port(1024));
assert!(! policy.allows_port(9000));

Fields

allowed: PortRanges

A list of port ranges that this policy allows.

In case we see a reject, we simply invert the policy by the assumption that allows policies take less space than reject ones.

Implementations

impl PortPolicy

pub fn new_reject_all() -> Self

Return a new PortPolicy that rejects all ports.

pub fn from_allowed_port_list(ports: Vec<u16>) -> Self

Create a PortPolicy from a list of allowed ports. All other ports will be rejected. The ports in the list may be in any order.

pub fn allows_port(&self, port: u16) -> bool

Return true iff port is allowed by this policy.

pub fn intern(self) -> Intern<Self>

Replace this PortPolicy with an interned copy, to save memory.

pub fn allows_some_port(&self) -> bool

Return true if this policy allows any ports at all.

Example

use tor_netdoc::types::policy::PortPolicy;

let policy: PortPolicy = "accept 22".parse().unwrap();
assert!(policy.allows_some_port());
let policy2: PortPolicy = "reject 1-65535".parse().unwrap();
assert!(! policy2.allows_some_port());

Trait Implementations

impl Clone for PortPolicy

fn clone(&self) -> PortPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PortPolicy

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

Formats the value using the given formatter.

impl Default for PortPolicy

fn default() -> PortPolicy

Returns the “default value” for a type.

impl Display for PortPolicy

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

Formats the value using the given formatter.

impl Eq for PortPolicy

impl FromStr for PortPolicy

fn from_str(s: &str) -> Result<Self, Self::Err>

Very bad parser for PortPolicy, please use parse2!

type Err = PolicyError

The associated error which can be returned from parsing.

impl GloballyInternable for PortPolicy

fn intern_cache() -> &'static InternCache<Self>

Returns a reference to the global cache instance of this type.

fn into_intern(self) -> Intern<Self>

where Self: Eq + Hash + 'static,

Places self into the global cache.

impl Hash for PortPolicy

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl ItemValueEncodable for PortPolicy

fn write_item_value_onto(&self, out: ItemEncoder<'_>) -> Result<(), Bug>

Write the item’s arguments, and any object, onto out

impl ItemValueParseable for PortPolicy

fn from_unparsed(item: UnparsedItem<'_>) -> Result<Self, EP>

Parse the item’s value

impl PartialEq for PortPolicy

fn eq(&self, other: &PortPolicy) -> 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 StructuralPartialEq for PortPolicy