Struct ApiKey

pub struct ApiKey(/* private fields */);

unc JSON RPC API key.

Implementations

impl ApiKey

pub const HEADER_NAME: &'static str = "x-api-key"

pub fn new<K: AsRef<[u8]>>(api_key: K) -> Result<Self, InvalidHeaderValue>

Creates a new API key.

See the auth module documentation for more information.

pub fn to_str(&self) -> Result<&str, ToStrError>

Returns a string slice if the API Key only contains visible ASCII chars.

pub fn as_bytes(&self) -> &[u8]

Returns the API key as a byte slice.

Trait Implementations

impl Clone for ApiKey

fn clone(&self) -> ApiKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKey

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

Formats the value using the given formatter.

impl Hash for ApiKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl HeaderEntry for ApiKey

type HeaderName = &'static str

type HeaderValue = HeaderValue

fn header_name(&self) -> &Self::HeaderName

fn header_pair(self) -> (Self::HeaderName, Self::HeaderValue)

impl PartialEq for ApiKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ApiKey

impl StructuralPartialEq for ApiKey