Struct ApiKey 

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

A validated Shopify API key.

This newtype ensures the API key is non-empty and provides type safety to prevent accidental misuse of raw strings.

Example

use shopify_sdk::ApiKey;

let key = ApiKey::new("my-api-key").unwrap();
assert_eq!(key.as_ref(), "my-api-key");

Implementations

impl ApiKey

pub fn new(key: impl Into<String>) -> Result<Self, ConfigError>

Creates a new validated API key.

Errors

Returns ConfigError::EmptyApiKey if the key is empty.

Trait Implementations

impl AsRef<str> for ApiKey

fn as_ref(&self) -> &str

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

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 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