Enum vsmtp_rule_engine::api::Object

pub enum Object {
    Ip4(Ipv4Addr),
    Ip6(Ipv6Addr),
    Rg4(IpRange<Ipv4Net>),
    Rg6(IpRange<Ipv6Net>),
    Address(Address),
    Fqdn(String),
    Regex(Regex),
    Identifier(String),
    Code(Reply),
}

vSL object type implementation. Objects are rust’s representation of rule engine variables. multiple types are supported.

NOTE: Objects are represented as an enum because it is easier to create containers for them.

Variants

Ip4(Ipv4Addr)

ip v4 address. (a.b.c.d)

Ip6(Ipv6Addr)

ip v6 address. (x:x:x:x:x:x:x:x)

Rg4(IpRange<Ipv4Net>)

an ip v4 range. (a.b.c.d/range)

Rg6(IpRange<Ipv6Net>)

an ip v6 range. (x:x:x:x:x:x:x:x/range)

Address(Address)

an email address (jones@foo.com)

Fqdn(String)

a valid fully qualified domain name (foo.com)

Regex(Regex)

a regex (^[a-z0-9.]+@foo.com$)

Identifier(String)

a user identifier.

Code(Reply)

a custom smtp reply code.

Implementations

impl Object

pub fn new_ip4(ip: impl AsRef<str>) -> Result<Object, Error>

Create a new ip v4 object.

Errors

• The value could not be converted.

pub fn new_ip6(ip: impl AsRef<str>) -> Result<Object, Error>

Create a new ip v6 object.

Errors

• The value could not be converted.

pub fn new_rg4(range: impl AsRef<str>) -> Result<Object, Error>

Create a new ip v4 range object.

Errors

• The value could not be converted.

pub fn new_rg6(range: impl AsRef<str>) -> Result<Object, Error>

Create a new ip v6 range object.

Errors

• The value could not be converted.

pub fn new_address(address: impl AsRef<str>) -> Result<Object, Error>

Create a new address object.

Errors

• The value could not be converted.

pub fn new_fqdn(domain: impl AsRef<str>) -> Result<Object, Error>

Create a new full qualified domain name object.

Errors

• The value could not be converted.

pub fn new_regex(regex: impl AsRef<str>) -> Result<Object, Error>

Create a new regex object.

Errors

• The value could not be converted.

pub fn new_file( path: impl AsRef<Path>, content_type: impl AsRef<str> ) -> Result<Vec<Dynamic, Global>, Error>

Create a new file object.

Errors

• The value could not be converted.

pub fn new_identifier(identifier: impl Into<String>) -> Object

Create a new identifier object.

pub fn new_code(code: u16, text: impl Into<String>) -> Object

Create a new code object.

pub fn new_code_enhanced<T>(code: u16, enhanced: T, text: T) -> Objectwhere T: Into<String>,

Create a new code object with an enhanced code.

impl Object

pub fn contains(&self, other: &Object) -> bool

check if the other object is contained in this object, return false automatically if the item cannot be contained in this object.

pub fn contains_str(&self, other: &str) -> bool

check if the other string is contained in this object, return false automatically if the item cannot be contained in this object.

Trait Implementations

impl AsRef<str> for Object

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Object

fn clone(&self) -> Object

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Object

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

Formats the value using the given formatter.

impl Display for Object

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

Formats the value using the given formatter.

impl PartialEq<Object> for Object

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