Struct PluginName 

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

A validated plugin name.

A PluginName is guaranteed to satisfy the plugin naming rules: [a-z][a-z0-9-]*, at most 64 characters, no path separators or dots.

Construct via TryFrom<String> or TryFrom<&str>; both delegate to the same validate_plugin_name predicate used throughout the plugin manager.

Examples

use zeph_plugins::PluginName;

let name: PluginName = "my-plugin".try_into().unwrap();
assert_eq!(name.as_str(), "my-plugin");
assert_eq!(name.to_string(), "my-plugin");

Implementations

impl PluginName

pub fn as_str(&self) -> &str

Returns the plugin name as a &str.

Examples

use zeph_plugins::PluginName;

let name: PluginName = "cool-plugin".try_into().unwrap();
assert_eq!(name.as_str(), "cool-plugin");

Trait Implementations

impl AsRef<str> for PluginName

fn as_ref(&self) -> &str

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

impl Clone for PluginName

fn clone(&self) -> PluginName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginName

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for PluginName

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

Formats the value using the given formatter.

impl Eq for PluginName

impl Hash for PluginName

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 PluginName

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

fn eq(&self, other: &PluginName) -> 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 PartialEq<&str> for PluginName

fn eq(&self, other: &&str) -> 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 PartialEq<String> for PluginName

fn eq(&self, other: &String) -> 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 PartialEq<str> for PluginName

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

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

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 PluginName

impl TryFrom<&str> for PluginName

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

Validate and wrap a plugin name from a string slice.

Errors

Returns PluginError::InvalidName when the string does not satisfy the naming rules: [a-z][a-z0-9-]*, at most 64 characters, no path separators or dots.

Examples

use zeph_plugins::PluginName;

let ok: PluginName = PluginName::try_from("another-plugin").unwrap();
assert_eq!(ok.as_str(), "another-plugin");

let err = PluginName::try_from("BAD");
assert!(err.is_err());

type Error = PluginError

The type returned in the event of a conversion error.

impl TryFrom<String> for PluginName

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

Validate and wrap a plugin name.

Errors

Returns PluginError::InvalidName when the string does not satisfy the naming rules: [a-z][a-z0-9-]*, at most 64 characters, no path separators or dots.

Examples

use zeph_plugins::PluginName;

let ok: PluginName = PluginName::try_from("valid-name".to_owned()).unwrap();
assert_eq!(ok.as_str(), "valid-name");

// Uppercase letters are rejected.
let err = PluginName::try_from("Invalid_Name".to_owned());
assert!(err.is_err());

// Empty string is rejected.
let err = PluginName::try_from(String::new());
assert!(err.is_err());

// Names longer than 64 characters are rejected.
let err = PluginName::try_from("a".repeat(65));
assert!(err.is_err());

type Error = PluginError

The type returned in the event of a conversion error.