Struct AuthScopes 

pub struct AuthScopes { /* private fields */ }

A set of OAuth scopes for Shopify API access.

This type handles parsing, deduplication, and implied scope logic. For example, write_products implies read_products.

Implied Scopes

Shopify’s scope system includes implied scopes:

• write_products implies read_products
• unauthenticated_write_products implies unauthenticated_read_products

This type automatically expands implied scopes when parsing.

Serialization

AuthScopes serializes to and deserializes from a comma-separated string for compact JSON representation:

use shopify_sdk::AuthScopes;

let scopes: AuthScopes = "read_products,write_orders".parse().unwrap();
let json = serde_json::to_string(&scopes).unwrap();
// JSON: "\"read_orders,read_products,write_orders\""

Example

use shopify_sdk::AuthScopes;

let scopes: AuthScopes = "read_products, write_orders".parse().unwrap();
assert!(!scopes.is_empty());

// Check if scopes cover another set
let required: AuthScopes = "read_products".parse().unwrap();
assert!(scopes.covers(&required));

Implementations

impl AuthScopes

pub fn new() -> Self

Creates an empty scope set.

pub fn is_empty(&self) -> bool

Returns true if the scope set is empty.

pub fn covers(&self, other: &Self) -> bool

Returns true if this scope set covers all scopes in other.

A scope set “covers” another if it contains all the scopes from the other set (considering implied scopes).

pub fn iter(&self) -> impl Iterator<Item = &str>

Returns an iterator over the scopes.

Trait Implementations

impl Clone for AuthScopes

fn clone(&self) -> AuthScopes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthScopes

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

Formats the value using the given formatter.

impl Default for AuthScopes

fn default() -> AuthScopes

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AuthScopes

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AuthScopes

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

Formats the value using the given formatter.

impl From<Vec<String>> for AuthScopes

fn from(scopes: Vec<String>) -> Self

Converts to this type from the input type.

impl FromStr for AuthScopes

type Err = ConfigError

The associated error which can be returned from parsing.

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

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

impl PartialEq for AuthScopes

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AuthScopes

impl StructuralPartialEq for AuthScopes