Struct Resource

pub struct Resource { /* private fields */ }

A resource represents something that can be accessed or acted upon.

Implementations

impl Resource

pub fn new_checked( id: impl Into<String>, resource_type: impl Into<String>, ) -> Result<Self, Error>

Create a new resource with validation.

Errors

Returns a ValidationError if the ID or resource type contains path traversal sequences or null characters.

pub fn new(id: impl Into<String>, resource_type: impl Into<String>) -> Self

Create a new resource.

Panics

This method panics if the ID or resource type contains path traversal sequences or null characters. For non-panicking validation, use new_checked.

pub fn id(&self) -> &str

Get the resource’s unique identifier.

pub fn resource_type(&self) -> &str

Get the resource type.

pub fn with_name(self, name: impl Into<String>) -> Self

Set the resource name.

pub fn name(&self) -> Option<&str>

Get the resource name.

pub fn set_name(&mut self, name: impl Into<String>)

Set the resource name.

pub fn with_path(self, path: impl Into<String>) -> Self

Set the resource path.

pub fn path(&self) -> Option<&str>

Get the resource path.

pub fn set_path(&mut self, path: impl Into<String>)

Set the resource path.

pub fn with_attribute( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add an attribute to the resource.

pub fn set_attribute( &mut self, key: impl Into<String>, value: impl Into<String>, )

Set an attribute on the resource.

pub fn attribute(&self, key: &str) -> Option<&str>

Get an attribute value.

pub fn attributes(&self) -> &HashMap<String, String>

Get all attributes.

pub fn remove_attribute(&mut self, key: &str) -> Option<String>

Remove an attribute.

pub fn has_attribute(&self, key: &str) -> bool

Check if the resource has a specific attribute.

pub fn effective_name(&self) -> &str

Get the effective name for display purposes.

pub fn matches_pattern(&self, pattern: &str) -> bool

Check if this resource matches a pattern. Patterns can include wildcards (*) and hierarchical matching.

pub fn is_under_path(&self, parent_path: &str) -> bool

Check if the resource is within a specific parent path.

pub fn parent_path(&self) -> Option<String>

Get the parent path of this resource.

Trait Implementations

impl Clone for Resource

fn clone(&self) -> Resource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Resource

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

Formats the value using the given formatter.

impl Display for Resource

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

Formats the value using the given formatter.

impl PartialEq for Resource

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

impl StructuralPartialEq for Resource