Struct ApiResource

pub struct ApiResource<'a, T: Display> { /* private fields */ }

Represents a single part of of a URI path. Where arguments are optional, there are interfaces which allow this object to check if an argument is required by either this component, or entities that are related to it.

Implementations

impl<'a, T: Display> ApiResource<'a, T>

Barebones basic implementation of an ApiResource.

use uri_resources::ApiResource;
let resource: ApiResource<'_, String> = ApiResource::new("resource");

pub fn new<'b: 'a>(name: &'b str) -> Self

Create a new instance of ApiResource.

Trait Implementations

impl<'a, T: Clone + Display> ArgedResource<T> for ApiResource<'a, T>

fn argument(&self) -> Option<&T>

Argument set on this resource.

fn required_by(&self) -> ArgRequiredBy

Determines if, and by whom, an argument set on this is required.

fn with_arg(&mut self, arg: T) -> &mut Self

Sets an argument on this resource component.

fn with_arg_required(&mut self, required: ArgRequiredBy) -> &mut Self

Sets if, and by whom, this component’s argument is required.

impl<T: Clone + Display> Clone for ApiResource<'_, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Clone + Display> CoreResource<T> for ApiResource<'a, T>

fn name(&self) -> String

The name of the resource component. Is used as the path component on digestion.

impl<'a, T: Debug + Display> Debug for ApiResource<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: Debug + Display + Clone> LinkedResource<'a, T> for ApiResource<'a, T>

fn child(&self) -> Option<&Self>

The child Resource node.

fn parent(&self) -> Option<&Self>

The parent Resource node.

fn is_child(&self) -> bool

If this is a child of another resource.

fn is_root(&self) -> bool

If this is the first resource of the path.

fn is_tail(&self) -> bool

If this is the last resource of the path.

fn with_child(&mut self, child: &mut ApiResource<'a, T>) -> Result<Box<Self>>

Adds a child node to this resource. Fails if the child is already set.

fn with_parent(&mut self, parent: &mut ApiResource<'a, T>) -> Result<Box<Self>>

Adds the parent node to this resource. Fails if the parent is already set.

impl<'a, T: Debug + Display + Clone> PathComponent for ApiResource<'a, T>

fn as_path_component(&self) -> Result<String>

Composes this as a path component.

fn compose(&self) -> Result<String>

Compose the entire heirarchy of components into one string.

impl<T: Display> WeightedResource for ApiResource<'_, T>

fn weight(&self) -> f32

The sorting weight value of this.

fn with_weight(&mut self, weight: f32) -> &Self

Determines the ordering weight to be used by pre-digestion sorting.

impl<'a, T: Clone + Debug + Display> Resource<'a, T> for ApiResource<'a, T>