Struct StateBuilder 

pub struct StateBuilder {
    pub port: u16,
    pub directory: Option<PathBuf>,
    pub max_upload: usize,
    pub ip: IpAddr,
    /* private fields */
}

Builder for server configuration

Fields

port: u16

The port which will be used to listen for connections.

directory: Option<PathBuf>

The directory to store malware samples if we’re keeping them.

max_upload: usize

Maximum upload size

ip: IpAddr

The IP to use for listening for connections

Implementations

impl StateBuilder

pub async fn new(db_string: &str, pg_cert: Option<PathBuf>) -> Result<Self>

Create the builder starting with the database configuration, and optionally, the certificate for communicating with Postgres.

Errors

An error occurs if the database configuration isn’t valid or if an error occurs connecting to the database.

pub fn port(self, port: u16) -> Self

Specify the port to listen on. Default: 8080

pub fn directory(self, directory: PathBuf) -> Self

Specify the directory to store malware samples if we’re keeping them.

Default: No directory, no file saving

pub fn max_upload(self, max_upload: usize) -> Self

Specify the maximum upload size in bytes. Default is 100 MiB.

pub fn ip(self, ip: IpAddr) -> Self

Indicate the IP address the server will list on. Default: 127.0.0.1

pub fn vt_client(self, vt_client: VirusTotalClient) -> Self

Available on crate feature vt only.

Provide the Virus Total API key.

pub async fn tls(self, cert_file: PathBuf, key_file: PathBuf) -> Result<Self>

Provide the certificate and private key for TLS mode. Files must match: both as PEM or both as DER.

Errors

An error results if either file doesn’t exist, not in the same format, or cannot be parsed.

pub fn enable_mdns(self) -> Self

Indicate that Malware DB should advertise itself via multicast DNS. Default is false.

pub async fn into_state(self) -> Result<State>

Generate the state object.

Errors

An error occurs if the database can’t be reached.