Struct Usecase 

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

A validated, case-sensitive name for an Objectstore workload.

Names must be 3–64 ASCII characters from [A-Za-z0-9_-]. Any permitted character may appear in any position, including names consisting entirely of underscores or hyphens. Names are never normalized.

Construction and deserialization both validate the name. The contents cannot be mutated after construction.

use objectstore_types::usecase::Usecase;

let name = Usecase::new("debug-files")?;
assert_eq!(name.as_str(), "debug-files");
assert!(Usecase::new("testing/org=999/injected").is_err());

Implementations

impl Usecase

pub fn new(name: impl Into<String>) -> Result<Self, InvalidUsecaseName>

Creates a validated usecase name from a borrowed or owned string.

Errors

Returns InvalidUsecaseName if the name violates the rules on Usecase.

pub fn as_str(&self) -> &str

Returns the usecase name as a string slice.

Trait Implementations

impl AsRef<str> for Usecase

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for Usecase

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for Usecase

fn clone(&self) -> Usecase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Usecase

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Usecase

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Usecase

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

Formats the value using the given formatter.

impl Eq for Usecase

impl From<Usecase> for String

fn from(name: Usecase) -> Self

Converts to this type from the input type.

impl FromStr for Usecase

type Err = InvalidUsecaseName

The associated error which can be returned from parsing.

fn from_str(name: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Usecase

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 Usecase

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Usecase

fn partial_cmp(&self, other: &Usecase) -> 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 Serialize for Usecase

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 Usecase

impl TryFrom<&str> for Usecase

type Error = InvalidUsecaseName

The type returned in the event of a conversion error.

fn try_from(name: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Usecase

type Error = InvalidUsecaseName

The type returned in the event of a conversion error.

fn try_from(name: String) -> Result<Self, Self::Error>

Performs the conversion.