Struct AppId

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

Filename-safe application identifier used as the leaf of storage paths.

Valid constructor input is non-empty lowercase ASCII letters, digits, and single hyphens. It cannot begin or end with a hyphen and cannot contain consecutive hyphens. Derived deserialization does not call Self::new, so consumers of untrusted serialized AppId values must validate them.

Examples

use ailloli_ui_app_storage::AppId;
assert_eq!(AppId::new("demo-2")?.as_str(), "demo-2");
assert!(AppId::new("Demo_2").is_err());

Implementations

impl AppId

pub fn new(value: impl Into<String>) -> Result<Self>

Validates and stores an application identifier.

Errors

Returns AppStorageError::InvalidAppId for empty input, non-lowercase ASCII letters, punctuation other than internal single hyphens, leading or trailing hyphens, or consecutive hyphens.

Examples

use ailloli_ui_app_storage::AppId;
assert!(AppId::new("2d-editor").is_ok());
assert!(AppId::new("-editor").is_err());

pub fn as_str(&self) -> &str

Borrows the stored identifier.

Examples

use ailloli_ui_app_storage::AppId;
assert_eq!(AppId::new("example")?.as_str(), "example");

pub fn env_prefix(&self) -> String

Returns the uppercase prefix used for app-specific environment variables.

ASCII alphanumeric characters are uppercased and every other character, including the normally valid hyphen, becomes _.

Examples

use ailloli_ui_app_storage::AppId;
assert_eq!(AppId::new("my-app")?.env_prefix(), "MY_APP");

Trait Implementations

impl Clone for AppId

fn clone(&self) -> AppId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AppId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AppId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for AppId

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 AppId

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AppId

impl StructuralPartialEq for AppId