Struct extrahop::ApiKey

pub struct ApiKey(_);

A REST API key which authenticates the caller to the ExtraHop.

Clients must pass an API key in the Authorization header of every request. The [extrahop::Client] type handles this automatically, or it can be done manually.

Examples

Manually adding the header to a request:

use reqwest::header::Authorization;
use extrahop::ApiKey;

let header = Authorization(ApiKey::new("your-key"));
let _req = reqwest::Client::new().get("https://extrahop.com/api/v1/devices").header(header).send();

As a best practice, API keys should be collected from the user at runtime, or stored in an environment variable or separate file; they should not be checked in with source code.

Methods

impl ApiKey

pub fn new<S: Into<String>>(key: S) -> Self

Creates a new ApiKey. This removes any leading or trailing whitespace.

pub fn to_header(self) -> Authorization<ApiKey>

Converts the API key to an Authorization header.

Trait Implementations

impl Eq for ApiKey

impl Clone for ApiKey

fn clone(&self) -> ApiKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<ApiKey> for ApiKey

fn eq(&self, other: &ApiKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ApiKey) -> bool

This method tests for !=.

impl From<String> for ApiKey

fn from(v: String) -> Self

Performs the conversion.

impl<'a> From<&'a str> for ApiKey

fn from(v: &str) -> Self

Performs the conversion.

impl From<ApiKey> for Authorization<ApiKey>

fn from(v: ApiKey) -> Self

Performs the conversion.

impl Debug for ApiKey

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

Formats the value using the given formatter.

impl FromStr for ApiKey

Parses a full HTTP header; required by reqwest::header::Scheme.

This should not be used for converting a regular string into an API key; for that, use ApiKey::new instead.

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Scheme for ApiKey

fn scheme() -> Option<&'static str>

An optional Scheme name.

fn fmt_scheme(&self, f: &mut Formatter) -> Result

Format the Scheme data into a header value.