Struct zbus_names::UniqueName

pub struct UniqueName<'name>(_);

String that identifies a unique bus name.

Examples

use core::convert::TryFrom;
use zbus_names::UniqueName;

// Valid unique names.
let name = UniqueName::try_from(":org.gnome.Service-for_you").unwrap();
assert_eq!(name, ":org.gnome.Service-for_you");
let name = UniqueName::try_from(":a.very.loooooooooooooooooo-ooooooo_0000o0ng.Name").unwrap();
assert_eq!(name, ":a.very.loooooooooooooooooo-ooooooo_0000o0ng.Name");

// Invalid unique names
UniqueName::try_from("").unwrap_err();
UniqueName::try_from("dont.start.with.a.colon").unwrap_err();
UniqueName::try_from(":double..dots").unwrap_err();
UniqueName::try_from(".").unwrap_err();
UniqueName::try_from(".start.with.dot").unwrap_err();
UniqueName::try_from(":no-dots").unwrap_err();

Implementations

impl<'name> UniqueName<'name>

pub fn as_str(&self) -> &str

The unique name as string.

pub fn from_str_unchecked(name: &'name str) -> Self

Create a new UniqueName from the given string.

Since the passed string is not checked for correctness, prefer using the TryFrom<&str> implementation.

pub fn from_string_unchecked(name: String) -> Self

Same as from_str_unchecked, except it takes an owned String.

Since the passed string is not checked for correctness, prefer using the TryFrom<String> implementation.

pub fn to_owned(&self) -> UniqueName<'static>

Creates an owned clone of self.

pub fn into_owned(self) -> UniqueName<'static>

Creates an owned clone of self.

Trait Implementations

impl<'name> Clone for UniqueName<'name>

fn clone(&self) -> UniqueName<'name>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'name> Debug for UniqueName<'name>

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

Formats the value using the given formatter.

impl Deref for UniqueName<'_>

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de: 'name, 'name> Deserialize<'de> for UniqueName<'name>

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

Deserialize this value from the given Serde deserializer.

impl Display for UniqueName<'_>

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

Formats the value using the given formatter.

impl<'name> From<&'_ UniqueName<'name>> for UniqueName<'name>

fn from(name: &UniqueName<'name>) -> Self

Performs the conversion.

impl<'unowned, 'owned: 'unowned> From<&'owned OwnedUniqueName> for UniqueName<'unowned>

fn from(name: &'owned OwnedUniqueName) -> Self

Performs the conversion.

impl From<OwnedUniqueName> for UniqueName<'static>

fn from(o: OwnedUniqueName) -> Self

Performs the conversion.

impl From<UniqueName<'_>> for OwnedUniqueName

fn from(name: UniqueName<'_>) -> Self

Performs the conversion.

impl<'name> From<UniqueName<'name>> for BusName<'name>

fn from(name: UniqueName<'name>) -> Self

Performs the conversion.

impl<'name> From<UniqueName<'name>> for Value<'name>

fn from(s: UniqueName<'name>) -> Self

Performs the conversion.

impl<'name> From<UniqueName<'name>> for OwnedValue

fn from(s: UniqueName<'name>) -> Self

Performs the conversion.

impl<'name> Hash for UniqueName<'name>

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, 

Feeds a slice of this type into the given Hasher.

impl<'name> NoneValue for UniqueName<'name>

type NoneType = &'name str

fn null_value() -> Self::NoneType

The none-equivalent value.

impl PartialEq<&'_ str> for UniqueName<'_>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<OwnedUniqueName> for UniqueName<'_>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<UniqueName<'_>> for BusName<'_>

fn eq(&self, other: &UniqueName<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<UniqueName<'_>> for OwnedUniqueName

fn eq(&self, other: &UniqueName<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'name> PartialEq<UniqueName<'name>> for UniqueName<'name>

fn eq(&self, other: &UniqueName<'name>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UniqueName<'name>) -> bool

This method tests for !=.

impl PartialEq<str> for UniqueName<'_>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'name> Serialize for UniqueName<'name>

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

Serialize this value into the given Serde serializer.

impl<'s> TryFrom<&'s str> for UniqueName<'s>

Try to create an UniqueName from a string.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'s str) -> Result<Self>

Performs the conversion.

impl TryFrom<()> for UniqueName<'_>

This never succeeds but is provided so it’s easier to pass Option::None values for API requiring Option<TryInto<impl BusName>>, since type inference won’t work here.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(_value: ()) -> Result<Self>

Performs the conversion.

impl<'name> TryFrom<OwnedValue> for UniqueName<'name>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: OwnedValue) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for UniqueName<'_>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'name> TryFrom<Value<'name>> for UniqueName<'name>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value<'name>) -> Result<Self>

Performs the conversion.

impl<'name> Type for UniqueName<'name>

fn signature() -> Signature<'static>

Get the signature for the implementing type.

impl<'name> Eq for UniqueName<'name>

impl<'name> StructuralEq for UniqueName<'name>

impl<'name> StructuralPartialEq for UniqueName<'name>