Struct Scope 

pub struct Scope(/* private fields */);

A normalized memory scope used for isolation and retention decisions.

The value is slash-delimited text. Empty path segments are removed and leading/trailing slashes are ignored, so "/tenant/a/" and "tenant/a" normalize to the same scope.

Example

use rig_memory_policy::Scope;

let scope = Scope::new("/tenant-a/project-1/");
assert_eq!(scope.as_str(), "tenant-a/project-1");
assert_eq!(scope.path(), vec!["tenant-a", "project-1"]);

Implementations

impl Scope

pub fn new(value: impl AsRef<str>) -> Self

Normalize value into a scope.

pub fn as_str(&self) -> &str

Return the normalized scope string.

pub fn is_empty(&self) -> bool

Return true when this scope has no path segments.

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

Split the scope into normalized path segments.

pub fn matches(&self, candidate: Option<&str>) -> bool

Return true when candidate is exactly this scope after normalization.

pub fn contains(&self, candidate: Option<&str>) -> bool

Return true when candidate is this scope or a descendant scope.

For example, tenant-a contains tenant-a/project-1, but does not contain tenant-ab.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.

impl Display for Scope

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

Formats the value using the given formatter.

impl From<&str> for Scope

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for Scope

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for Scope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Scope

fn cmp(&self, other: &Scope) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Scope

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

fn partial_cmp(&self, other: &Scope) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Scope

impl StructuralPartialEq for Scope