Struct ApiSecretKey 

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

A validated Shopify API secret key.

This newtype ensures the secret key is non-empty and masks its value in debug output to prevent accidental exposure in logs.

Security

The Debug implementation masks the secret value, displaying only ApiSecretKey(*****) instead of the actual key.

Example

use shopify_sdk::ApiSecretKey;

let secret = ApiSecretKey::new("my-secret").unwrap();
assert_eq!(format!("{:?}", secret), "ApiSecretKey(*****)");

Implementations

impl ApiSecretKey

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

Creates a new validated API secret key.

Errors

Returns ConfigError::EmptyApiSecretKey if the key is empty.

Trait Implementations

impl AsRef<str> for ApiSecretKey

fn as_ref(&self) -> &str

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

impl Clone for ApiSecretKey

fn clone(&self) -> ApiSecretKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiSecretKey

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

Formats the value using the given formatter.

impl PartialEq for ApiSecretKey

fn eq(&self, other: &ApiSecretKey) -> 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 ApiSecretKey

impl StructuralPartialEq for ApiSecretKey