Struct Scope 

pub struct Scope {
    pub name: String,
    pub value: String,
}

A single scope value of an object.

Scopes are used in a hierarchy in object IDs.

Fields

name: String

Identifies the scope.

Examples are organization or project.

value: String

The value of the scope.

This can be the identifier of a

Implementations

impl Scope

pub fn create<V>(name: &str, value: V) -> Result<Self, InvalidScopeError>

where V: Display,

Creates and validates a new scope.

The name and value must be non-empty.

Examples

use objectstore_types::scope::Scope;

let scope = Scope::create("organization", "17").unwrap();
assert_eq!(scope.name(), "organization");
assert_eq!(scope.value(), "17");

// Empty names or values are invalid
let invalid_scope = Scope::create("", "value");
assert!(invalid_scope.is_err());

pub fn name(&self) -> &str

Returns the name of the scope.

pub fn value(&self) -> &str

Returns the value of the scope.

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 FromIterator<Scope> for Scopes

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = Scope>,

Creates a value from an iterator.

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