Struct 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 header_acl_default(self, allow: bool) -> Self

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

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

Set default action for URL paths 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<Ip: IntoIpRange>( self, ip_range: Ip, ) -> Result<Self, AddError>

Adds an IP range to the allowed IP ranges.

pub fn remove_allowed_ip_range<Ip: IntoIpRange>( self, ip_range: Ip, ) -> Result<Self, AddError>

Removes an IP range from the allowed IP ranges.

pub fn allowed_ip_ranges<Ip: IntoIpRange>( self, ip_ranges: Vec<Ip>, ) -> 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<Ip: IntoIpRange>( self, ip_range: Ip, ) -> Result<Self, AddError>

Adds an IP range to the denied IP ranges.

pub fn remove_denied_ip_range<Ip: IntoIpRange>( self, ip_range: Ip, ) -> Result<Self, AddError>

Removes an IP range from the denied IP ranges.

pub fn denied_ip_ranges<Ip: IntoIpRange>( self, ip_ranges: Vec<Ip>, ) -> 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, sock_addr: SocketAddr, ) -> 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, SocketAddr>, ) -> Result<Self, AddError>

Sets the static DNS mappings.

pub fn clear_static_dns_mappings(self) -> Self

Clears the static DNS mappings.

pub fn add_allowed_header( self, header: String, value: Option<String>, ) -> Result<Self, AddError>

Adds a header to the allowed headers.

pub fn remove_allowed_header(self, header: &str) -> Self

Removes a header from the allowed headers.

pub fn allowed_headers( self, headers: HashMap<String, Option<String>>, ) -> Result<Self, AddError>

Sets the allowed headers.

pub fn clear_allowed_headers(self) -> Self

Clears the allowed headers.

pub fn add_denied_header( self, header: String, value: Option<String>, ) -> Result<Self, AddError>

Adds a header to the denied headers.

pub fn remove_denied_header(self, header: &str) -> Self

Removes a header from the denied headers.

pub fn denied_headers( self, headers: HashMap<String, Option<String>>, ) -> Result<Self, AddError>

Sets the denied headers.

pub fn clear_denied_headers(self) -> Self

Clears the denied headers.

pub fn add_allowed_url_path(self, url_path: String) -> Result<Self, AddError>

Adds a URL path to the allowed URL paths.

pub fn remove_allowed_url_path(self, url_path: &str) -> Self

Removes a URL path from the allowed URL paths.

pub fn allowed_url_paths(self, url_paths: Vec<String>) -> Result<Self, AddError>

Sets the allowed URL paths.

pub fn clear_allowed_url_paths(self) -> Self

Clears the allowed URL paths.

pub fn add_denied_url_path(self, url_path: String) -> Result<Self, AddError>

Adds a URL path to the denied URL paths.

pub fn remove_denied_url_path(self, url_path: &str) -> Self

Removes a URL path from the denied URL paths.

pub fn denied_url_paths(self, url_paths: Vec<String>) -> Result<Self, AddError>

Sets the denied URL paths.

pub fn clear_denied_url_paths(self) -> Self

Clears the denied URL paths.

pub fn build(self) -> HttpAcl

Builds the HttpAcl.

pub fn build_full(self, validate_fn: Option<ValidateFn>) -> HttpAcl

Builds the HttpAcl.

pub fn try_build_full( self, validate_fn: Option<ValidateFn>, ) -> Result<HttpAcl, AddError>

Builds the HttpAcl and returns an error if the configuration is invalid. This is used for deserialized ACLs as the URL Path Routers need to be built.

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

Builds the HttpAcl and returns an error if the configuration is invalid. This is used for deserialized ACLs as the URL Path Routers need to be built.

Trait Implementations

impl Clone for HttpAclBuilder

fn clone(&self) -> HttpAclBuilder

Returns a duplicate 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 for HttpAclBuilder

fn eq(&self, other: &Self) -> 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.