http_acl/
error.rs

1//! Error types for the HTTP ACL library.
2
3use crate::acl::HttpRequestMethod;
4use std::net::{IpAddr, SocketAddr};
5use std::ops::RangeInclusive;
6
7use thiserror::Error;
8
9/// Represents an error that can occur when adding a new allowed or denied entity to an ACL.
10#[non_exhaustive]
11#[derive(Clone, Debug, Eq, Hash, PartialEq, Error)]
12pub enum AddError {
13    /// The HTTP method is already allowed.
14    #[error("The HTTP method `{0:?}` is already allowed.")]
15    AlreadyAllowedMethod(HttpRequestMethod),
16    /// The HTTP method is already denied.
17    #[error("The HTTP method `{0:?}` is already denied.")]
18    AlreadyDeniedMethod(HttpRequestMethod),
19    /// The host is already allowed.
20    #[error("The host `{0}` is already allowed.")]
21    AlreadyAllowedHost(String),
22    /// The host is already denied.
23    #[error("The host `{0}` is already denied.")]
24    AlreadyDeniedHost(String),
25    /// The port range is already allowed.
26    #[error("The port range `{0:?}` is already allowed.")]
27    AlreadyAllowedPortRange(RangeInclusive<u16>),
28    /// The port range is already denied.
29    #[error("The port range `{0:?}` is already denied.")]
30    AlreadyDeniedPortRange(RangeInclusive<u16>),
31    /// The IP range is already allowed.
32    #[error("The IP range `{0:?}` is already allowed.")]
33    AlreadyAllowedIpRange(RangeInclusive<IpAddr>),
34    /// The IP range is already denied.
35    #[error("The IP range `{0:?}` is already denied.")]
36    AlreadyDeniedIpRange(RangeInclusive<IpAddr>),
37    /// The IP range is not a global IP range.
38    /// This error is returned if the ACL is configured to disallow non-global IP ranges.
39    #[error(
40        "The IP range `{0:?}` is not a global IP range, and non-global IP ranges are not allowed."
41    )]
42    NonGlobalIpRange(RangeInclusive<IpAddr>),
43    /// The header is already allowed.
44    #[error("The header `{0}` is already allowed.")]
45    AlreadyAllowedHeader(String, Option<String>),
46    /// The header is already denied.
47    #[error("The header `{0}` is already denied.")]
48    AlreadyDeniedHeader(String, Option<String>),
49    /// The URL path is already allowed.
50    #[error("The URL path `{0}` is already allowed.")]
51    AlreadyAllowedUrlPath(String),
52    /// The URL path is already denied.
53    #[error("The URL path `{0}` is already denied.")]
54    AlreadyDeniedUrlPath(String),
55    /// The static DNS mapping is already present.
56    #[error("The static DNS mapping for `{0}`-`{1}` is already present.")]
57    AlreadyPresentStaticDnsMapping(String, SocketAddr),
58    /// The entity is not allowed or denied because it is invalid.
59    #[error("The entity `{0}` is not allowed or denied because it is invalid.")]
60    InvalidEntity(String),
61    /// The entity is not unique.
62    #[error("The entity `{0}` is not unique.")]
63    NotUnique(String),
64    /// The entity overlaps with another.
65    #[error("The entity `{0}` overlaps with another.")]
66    Overlaps(String),
67    /// The entity is both allowed and denied.
68    #[error("The entity `{0}` is both allowed and denied.")]
69    BothAllowedAndDenied(String),
70    /// General error with a message.
71    #[error("An error occurred: `{0}`")]
72    Error(String),
73}
http_acl/error.rs

http_acl/
error.rs
