Struct ResourceInfo 

#[non_exhaustive]
pub struct ResourceInfo {
    pub url: CompactString,
    pub description: Option<CompactString>,
    pub mime_type: Option<CompactString>,
    pub service_name: Option<CompactString>,
    pub tags: Vec<CompactString>,
    pub icon_url: Option<CompactString>,
}

Human-readable metadata describing the paid resource.

Per the x402 v2 spec §5.1.2, only url is required. description and mimeType are optional because many resources (e.g. raw API endpoints) have no meaningful MIME type or prose description. serviceName, tags, and iconUrl are optional discovery metadata consumed by marketplace/bazaar-style aggregators.

The field names use camelCase to align with the wire format.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

url: CompactString

Canonical URL of the resource.

description: Option<CompactString>

Optional human-readable description.

mime_type: Option<CompactString>

Optional MIME type.

service_name: Option<CompactString>

Human-readable name of the service hosting the resource.

Printable ASCII, max 32 characters per spec §5.1.2.

tags: Vec<CompactString>

Topical tags for the service, used for discovery filtering.

Max 5 entries; each printable ASCII, max 32 characters, per spec §5.1.2.

icon_url: Option<CompactString>

Absolute https/http URL to an icon representing the service.

Max 2048 characters per spec §5.1.2.

Implementations

impl ResourceInfo

pub fn new(url: impl Into<CompactString>) -> Self

Constructs a ResourceInfo carrying just a URL.

pub fn with_description(self, description: impl Into<CompactString>) -> Self

Builder: sets description.

pub fn with_mime_type(self, mime_type: impl Into<CompactString>) -> Self

Builder: sets mimeType.

pub fn with_service_name(self, service_name: impl Into<CompactString>) -> Self

Builder: sets serviceName.

pub fn with_tags(self, tags: Vec<CompactString>) -> Self

Builder: replaces the tags list.

pub fn with_tag(self, tag: impl Into<CompactString>) -> Self

Builder: appends a single tag.

pub fn with_icon_url(self, icon_url: impl Into<CompactString>) -> Self

Builder: sets iconUrl.

Trait Implementations

impl Clone for ResourceInfo

fn clone(&self) -> ResourceInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResourceInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ResourceInfo

impl PartialEq for ResourceInfo

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ResourceInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ResourceInfo