Struct zvariant::Signature

pub struct Signature<'a> { /* fields omitted */ }

String that identifies the type of an encoded value.

Examples

use core::convert::TryFrom;
use zvariant::Signature;

// Valid signatures
let s = Signature::try_from("").unwrap();
assert_eq!(s, "");
let s = Signature::try_from("y").unwrap();
assert_eq!(s, "y");
let s = Signature::try_from("xs").unwrap();
assert_eq!(s, "xs");
let s = Signature::try_from("(ysa{sd})").unwrap();
assert_eq!(s, "(ysa{sd})");
let s = Signature::try_from("a{sd}").unwrap();
assert_eq!(s, "a{sd}");

// Invalid signatures
Signature::try_from("z").unwrap_err();
Signature::try_from("(xs").unwrap_err();
Signature::try_from("xs)").unwrap_err();
Signature::try_from("s/").unwrap_err();
Signature::try_from("a").unwrap_err();
Signature::try_from("a{yz}").unwrap_err();

This is implemented so that multiple instances can share the same underlying signature string. Use slice method to create new signature that represents a portion of a signature

Implementations

impl<'a> Signature<'a>

pub fn as_str(&self) -> &str

The signature as a string.

pub fn as_bytes(&self) -> &[u8]

The signature bytes.

pub fn from_bytes_unchecked<'s: 'a>(bytes: &'s [u8]) -> Self

Create a new Signature from given bytes.

Since the passed bytes are not checked for correctness, it’s provided for ease of Type implementations.

pub fn from_static_bytes_unchecked(bytes: &'static [u8]) -> Self

Same as from_bytes_unchecked, except it takes a static reference.

pub fn from_str_unchecked<'s: 'a>(signature: &'s str) -> Self

Same as from_bytes_unchecked, except it takes a string reference.

pub fn from_static_str_unchecked(signature: &'static str) -> Self

Same as from_str_unchecked, except it takes a static string reference.

pub fn from_string_unchecked(signature: String) -> Self

Same as from_str_unchecked, except it takes an owned String.

pub fn len(&self) -> usize

the signature’s length.

pub fn is_empty(&self) -> bool

if the signature is empty.

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

Creates an owned clone of self.

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

Creates an owned clone of self.

pub fn slice(&self, range: impl RangeBounds<usize>) -> Self

Returns a slice of self for the provided range.

Panics

Requires that begin <= end and end <= self.len(), otherwise slicing will panic.

Trait Implementations

impl<'a> Basic for Signature<'a>

const SIGNATURE_CHAR: char

The type signature, as a character.

const SIGNATURE_STR: &'static str

The type signature, as a string.

const ALIGNMENT: usize

👎 Deprecated since 2.0.2:

Please use the alignment function instead

The required padding alignment.

fn alignment(format: EncodingFormat) -> usize

The required padding alignment for the given format.

impl<'a> Clone for Signature<'a>

fn clone(&self) -> Signature<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Signature<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for Signature<'a>

type Target = str

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de: 'a, 'a> Deserialize<'de> for Signature<'a>

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

Deserialize this value from the given Serde deserializer.

impl<'a> Display for Signature<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'_ Signature<'a>> for String

fn from(value: &Signature<'a>) -> String

Performs the conversion.

impl<'a> From<&'a Signature<'a>> for Value<'a>

fn from(v: &'a Signature<'a>) -> Self

Performs the conversion.

impl From<OwnedSignature> for Signature<'static>

fn from(o: OwnedSignature) -> Self

Performs the conversion.

impl<'a> From<Signature<'a>> for String

fn from(value: Signature<'a>) -> String

Performs the conversion.

impl<'a> From<Signature<'a>> for OwnedSignature

fn from(o: Signature<'a>) -> Self

Performs the conversion.

impl<'a> From<Signature<'a>> for Value<'a>

fn from(v: Signature<'a>) -> Self

Performs the conversion.

impl<'a> From<Signature<'a>> for OwnedValue

fn from(v: Signature<'a>) -> Self

Performs the conversion.

impl<'a> Hash for Signature<'a>

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<'a> PartialEq<&'_ str> for Signature<'a>

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<'a, 'b> PartialEq<Signature<'a>> for Signature<'b>

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

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<'a> Serialize for Signature<'a>

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

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a [u8]> for Signature<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a [u8]) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a OwnedValue> for &'a Signature<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: &'a OwnedValue) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Value<'a>> for &'a Signature<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a Value<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Value<'a>> for Signature<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a Value<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for Signature<'a>

Try to create a Signature from a string.

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<OwnedValue> for Signature<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: OwnedValue) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<String> for Signature<'a>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<Value<'a>> for Signature<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Type for Signature<'a>

fn signature() -> Signature<'static>

Get the signature for the implementing type.

impl<'a> Eq for Signature<'a>

impl<'a> StructuralEq for Signature<'a>