Enum bp7::eid::EndpointID

pub enum EndpointID {
    Dtn(u8, DtnAddress),
    DtnNone(u8, u8),
    Ipn(u8, IpnAddress),
}

Represents an endpoint in various addressing schemes.

Either the none endpoint, a dtn one or an ipn endpoint.

Variants

Dtn(u8, DtnAddress)

DtnNone(u8, u8)

Ipn(u8, IpnAddress)

Implementations

impl EndpointID

pub fn new() -> EndpointID

Default returns a dtn:none endpoint

pub fn with_dtn(host_with_endpoint: &str) -> Result<EndpointID, EndpointIdError>

Create a new EndpointID with dtn addressing scheme

This can either be a host id such as dtn://node1/ or include an application agents endpoint, e.g., dtn://node1/endpoint1 or for non-singletons dtn://group1/~endpoint1

pub const fn none() -> EndpointID

Create a new 'dtn:none' endpoint

This is the same as DTN_NONE

pub fn with_ipn(host: u64, endpoint: u64) -> Result<EndpointID, EndpointIdError>

Create a new EndpointID with ipn addressing scheme

This can either be a host id such as 'ipn:23.0' or include an application agents endpoint, e.g., 'ipn:23.42'

host must be > 0

pub fn new_endpoint(&self, ep: &str) -> Result<EndpointID, EndpointIdError>

Generate a new Endpoint ID from existing one with a specific service endpoint

Keeps scheme and host specific parts from original eid.

Examples

use bp7::eid::*;

// For ipn addresses

let ipn_addr_1 = EndpointID::with_ipn(23, 42).unwrap();
let ipn_addr_2 = EndpointID::with_ipn(23, 7).unwrap();

assert_eq!(ipn_addr_1, ipn_addr_2.new_endpoint("42").unwrap());

let ipn_addr_1 = EndpointID::with_ipn(23, 42).unwrap();    

assert!(ipn_addr_1.new_endpoint("-42").is_err());    

// For dtn addresses
let dtn_addr_1 = EndpointID::with_dtn( "//node1/incoming").unwrap();
let dtn_addr_2 = EndpointID::with_dtn( "//node1/inbox").unwrap();

assert_eq!(dtn_addr_1, dtn_addr_2.new_endpoint("incoming").unwrap());

// For non endpoint this is not possible

let dtn_addr_none = EndpointID::none();    

assert!(dtn_addr_none.new_endpoint("incoming").is_err());    
    

pub fn scheme(&self) -> String

pub fn scheme_specific_part_dtn(&self) -> Option<String>

pub fn scheme_specific_part_ipn(&self) -> Option<IpnAddress>

impl EndpointID

pub fn node(&self) -> Option<String>

Returns the plain node name without URL scheme

pub fn node_id(&self) -> Option<String>

Returns the node name including URL scheme

pub fn is_node_id(&self) -> bool

pub fn validate(&self) -> Result<(), EndpointIdError>

Trait Implementations

impl Clone for EndpointID

fn clone(&self) -> EndpointID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointID

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

Formats the value using the given formatter.

impl Default for EndpointID

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for EndpointID

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

Deserialize this value from the given Serde deserializer.

impl Display for EndpointID

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

Formats the value using the given formatter.

impl Eq for EndpointID

impl Hash for EndpointID

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<EndpointID> for EndpointID

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

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

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

This method tests for !=.

impl Serialize for EndpointID

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

Serialize this value into the given Serde serializer.

impl StructuralEq for EndpointID

impl StructuralPartialEq for EndpointID

impl TryFrom<&'_ str> for EndpointID

type Error = EndpointIdError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<IpnAddress> for EndpointID

type Error = EndpointIdError

The type returned in the event of a conversion error.

fn try_from(item: IpnAddress) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for EndpointID

Load EndpointID from URL string.

Support for ipn and dtn schemes.

type Error = EndpointIdError

The type returned in the event of a conversion error.

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

Performs the conversion.