Skip to main content

ResourcePath

Struct ResourcePath 

Source
pub struct ResourcePath {
    pub http_method: HttpMethod,
    pub operation: ResourceOperation,
    pub ids: &'static [&'static str],
    pub template: &'static str,
}
Expand description

A path configuration for a REST resource operation.

Each ResourcePath defines how to access a resource for a specific operation, including the HTTP method, required IDs, and URL template.

§Path Templates

Templates use {id_name} placeholders for ID interpolation:

  • products/{id} - Single ID
  • products/{product_id}/variants/{id} - Multiple IDs

§Example

use shopify_sdk::rest::{ResourcePath, ResourceOperation};
use shopify_sdk::HttpMethod;

const PRODUCT_FIND: ResourcePath = ResourcePath::new(
    HttpMethod::Get,
    ResourceOperation::Find,
    &["id"],
    "products/{id}",
);

Fields§

§http_method: HttpMethod

The HTTP method for this path.

§operation: ResourceOperation

The operation this path is used for.

§ids: &'static [&'static str]

Required ID parameters in order (e.g., ["product_id", "id"]).

§template: &'static str

The URL template with {id} placeholders.

Implementations§

Source§

impl ResourcePath

Source

pub const fn new( http_method: HttpMethod, operation: ResourceOperation, ids: &'static [&'static str], template: &'static str, ) -> Self

Creates a new ResourcePath.

This is a const fn to allow paths to be defined as constants.

§Arguments
  • http_method - The HTTP method for this path
  • operation - The operation this path handles
  • ids - Required ID parameter names in order
  • template - The URL template with {id} placeholders
Source

pub const fn id_count(&self) -> usize

Returns the number of required IDs for this path.

Source

pub fn matches_ids(&self, available_ids: &[&str]) -> bool

Checks if all required IDs are available.

§Arguments
  • available_ids - Slice of available ID parameter names

Trait Implementations§

Source§

impl Clone for ResourcePath

Source§

fn clone(&self) -> ResourcePath

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ResourcePath

Source§

impl Debug for ResourcePath

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ResourcePath

Source§

impl PartialEq for ResourcePath

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for ResourcePath

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more