Struct bindle::Id

pub struct Id { /* fields omitted */ }

A parsed representation of an ID string for a bindle. This is currently defined as an arbitrary path with a version string at the end.

Examples of valid ID strings include:

• foo/0.1.0
• example.com/foo/1.2.3
• example.com/a/longer/path/foo/1.10.0-rc.1

An Id can be parsed from any string using the .parse() method:

use bindle::Id;

let id: Id = "example.com/foo/1.2.3".parse().expect("should parse");
println!("{}", id);

An Id can also be parsed from any string using the TryFrom or TryInto trait:

use bindle::Id;
use std::convert::TryInto;

let id: Id = String::from("example.com/a/longer/path/foo/1.10.0-rc.1")
    .try_into().expect("should parse");
println!("{}", id);

Implementations

impl Id

pub fn name(&self) -> &str

Returns the name part of the ID

pub fn version(&self) -> &Version

pub fn version_string(&self) -> String

Returns the version part of the ID. This is returned as a String as it is a conversion from the underlying semver

pub fn sha(&self) -> String

Returns the SHA256 sum of this Id for use as a common identifier

We don't typically want to store a bindle with its name and version number. This would impose both naming constraints on the bindle and security issues on the storage layout. So this function hashes the name/version data (which together MUST be unique in the system) and uses the resulting hash as the canonical name. The hash is guaranteed to be in the character set [a-zA-Z0-9].

Trait Implementations

impl Clone for Id

pub fn clone(&self) -> Id

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Id

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Id

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Id

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

Formats the value using the given formatter.

impl<'_> From<&'_ Id> for Id

pub fn from(id: &Id) -> Self

Performs the conversion.

impl FromStr for Id

type Err = ParseError

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<Self, ParseError>

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

impl Serialize for Id

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

Serialize this value into the given Serde serializer.

impl<'_> TryFrom<&'_ String> for Id

type Error = ParseError

The type returned in the event of a conversion error.

pub fn try_from(value: &String) -> Result<Self, ParseError>

Performs the conversion.

impl<'_> TryFrom<&'_ str> for Id

type Error = ParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for Id

type Error = ParseError

The type returned in the event of a conversion error.

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

Performs the conversion.