Struct splunk::ServerConfig

pub struct ServerConfig {
    pub hostname: String,
    pub port: u16,
    /* private fields */
}

What we’re going to use to connect to the server

Fields

hostname: String

Server hostname - just something like example.com (or an IP, if you’re like that)

port: u16

Port - defaults to 8089

Implementations

impl ServerConfig

pub fn get_url(&self, endpoint: &str) -> Result<Url, String>

build a url based on the server/endpoint

use std::str::FromStr;
use reqwest::Url;
use splunk::hec::HecClient;

let client = HecClient::new("token", "localhost");
let expected_response = Url::from_str("https://localhost:8088/hello").unwrap();
assert_eq!(client.serverconfig.get_url("/hello").unwrap(), expected_response);

pub fn new(hostname: String) -> Self

Point at a server

pub fn with_token(self, token: String) -> Self

Set the authentication method to token and set the token

pub fn with_username_password(self, username: String, password: String) -> Self

Set the authentication method to basic and set the credentials

pub fn token(&self) -> Option<String>

Get the token from the auth method, if it exists

pub async fn do_get(&self, endpoint: &str) -> Result<Response, String>

make a get request to a given endpoint

pub async fn do_get_with_headers( &self, endpoint: &str, add_headers: HeaderMap ) -> Result<Response, String>

make a get request to a given endpoint and set the headers

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

Set the port

pub fn with_hostname(self, hostname: String) -> Self

Set the hostname

pub fn with_verify_tls(self, verify_tls: bool) -> Self

Do we verify TLS on send?

pub fn try_from_env( configtype: ServerConfigType ) -> Result<ServerConfig, String>

Grabs a ServerConfig from environment variables

Trait Implementations

impl Clone for ServerConfig

fn clone(&self) -> ServerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServerConfig

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

Formats the value using the given formatter.

impl Default for ServerConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ServerConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ServerConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.