Struct http_acl::acl::HttpAclBuilder

pub struct HttpAclBuilder { /* private fields */ }

A builder for HttpAcl.

Implementations

impl HttpAclBuilder

pub fn new() -> Self

Create a new HttpAclBuilder.

pub fn http(self, allow: bool) -> Self

Sets whether HTTP is allowed.

pub fn https(self, allow: bool) -> Self

Sets whether HTTPS is allowed.

pub fn private_ip_ranges(self, allow: bool) -> Self

Sets whether private IP ranges are allowed.

pub fn method_acl_default(self, allow: bool) -> Self

Set default action for HTTP methods if no ACL match is found.

pub fn host_acl_default(self, allow: bool) -> Self

Set default action for hosts if no ACL match is found.

pub fn port_acl_default(self, allow: bool) -> Self

Set default action for ports if no ACL match is found.

pub fn ip_acl_default(self, allow: bool) -> Self

Set default action for IPs if no ACL match is found.

pub fn add_allowed_method( self, method: impl Into<HttpRequestMethod> ) -> Result<Self, AddError>

Adds a method to the allowed methods.

pub fn remove_allowed_method(self, method: impl Into<HttpRequestMethod>) -> Self

Removes a method from the allowed methods.

pub fn allowed_methods( self, methods: Vec<impl Into<HttpRequestMethod>> ) -> Result<Self, AddError>

Sets the allowed methods.

pub fn clear_allowed_methods(self) -> Self

Clears the allowed methods.

pub fn add_denied_method( self, method: impl Into<HttpRequestMethod> ) -> Result<Self, AddError>

Adds a method to the denied methods.

pub fn remove_denied_method(self, method: impl Into<HttpRequestMethod>) -> Self

Removes a method from the denied methods.

pub fn denied_methods( self, methods: Vec<impl Into<HttpRequestMethod>> ) -> Result<Self, AddError>

Sets the denied methods.

pub fn clear_denied_methods(self) -> Self

Clears the denied methods.

pub fn add_allowed_host(self, host: String) -> Result<Self, AddError>

Sets whether public IP ranges are allowed.

pub fn remove_allowed_host(self, host: String) -> Self

Removes a host from the allowed hosts.

pub fn allowed_hosts(self, hosts: Vec<String>) -> Result<Self, AddError>

Sets the allowed hosts.

pub fn clear_allowed_hosts(self) -> Self

Clears the allowed hosts.

pub fn add_denied_host(self, host: String) -> Result<Self, AddError>

Adds a host to the denied hosts.

pub fn remove_denied_host(self, host: String) -> Self

Removes a host from the denied hosts.

pub fn denied_hosts(self, hosts: Vec<String>) -> Result<Self, AddError>

Sets the denied hosts.

pub fn clear_denied_hosts(self) -> Self

Clears the denied hosts.

pub fn add_allowed_port_range( self, port_range: RangeInclusive<u16> ) -> Result<Self, AddError>

Adds a port range to the allowed port ranges.

pub fn remove_allowed_port_range(self, port_range: RangeInclusive<u16>) -> Self

Removes a port range from the allowed port ranges.

pub fn allowed_port_ranges( self, port_ranges: Vec<RangeInclusive<u16>> ) -> Result<Self, AddError>

Sets the allowed port ranges.

pub fn clear_allowed_port_ranges(self) -> Self

Clears the allowed port ranges.

pub fn add_denied_port_range( self, port_range: RangeInclusive<u16> ) -> Result<Self, AddError>

Adds a port range to the denied port ranges.

pub fn remove_denied_port_range(self, port_range: RangeInclusive<u16>) -> Self

Removes a port range from the denied port ranges.

pub fn denied_port_ranges( self, port_ranges: Vec<RangeInclusive<u16>> ) -> Result<Self, AddError>

Sets the denied port ranges.

pub fn clear_denied_port_ranges(self) -> Self

Clears the denied port ranges.

pub fn add_allowed_ip_range(self, ip_range: IpNet) -> Result<Self, AddError>

Adds an IP range to the allowed IP ranges.

pub fn remove_allowed_ip_range(self, ip_range: IpNet) -> Self

Removes an IP range from the allowed IP ranges.

pub fn allowed_ip_ranges(self, ip_ranges: Vec<IpNet>) -> Result<Self, AddError>

Sets the allowed IP ranges.

pub fn clear_allowed_ip_ranges(self) -> Self

Clears the allowed IP ranges.

pub fn add_denied_ip_range(self, ip_range: IpNet) -> Result<Self, AddError>

Adds an IP range to the denied IP ranges.

pub fn remove_denied_ip_range(self, ip_range: IpNet) -> Self

Removes an IP range from the denied IP ranges.

pub fn denied_ip_ranges(self, ip_ranges: Vec<IpNet>) -> Result<Self, AddError>

Sets the denied IP ranges.

pub fn clear_denied_ip_ranges(self) -> Self

Clears the denied IP ranges.

pub fn add_static_dns_mapping( self, host: String, ip: IpAddr ) -> Result<Self, AddError>

Add a static DNS mapping.

pub fn remove_static_dns_mapping(self, host: &str) -> Self

Removes a static DNS mapping.

pub fn static_dns_mappings( self, mappings: HashMap<String, IpAddr> ) -> Result<Self, AddError>

Sets the static DNS mappings.

pub fn build(self) -> HttpAcl

Builds the HttpAcl.

pub fn try_build(self) -> Result<HttpAcl, AddError>

Builds the HttpAcl and returns an error if the configuration is invalid. This can be used as a validity check for deserialized ACLs that were genrated externally.

Trait Implementations

impl Clone for HttpAclBuilder

fn clone(&self) -> HttpAclBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HttpAclBuilder

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

Formats the value using the given formatter.

impl Default for HttpAclBuilder

fn default() -> HttpAclBuilder

Returns the “default value” for a type.

impl PartialEq<HttpAclBuilder> for HttpAclBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for HttpAclBuilder