Struct PortPolicy 

pub struct PortPolicy { /* private fields */ }

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));

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) -> Arc<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 Display for PortPolicy

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

Formats the value using the given formatter.

impl FromStr for PortPolicy

type Err = PolicyError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

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 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 Eq for PortPolicy

impl StructuralPartialEq for PortPolicy

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes