Struct AeAddr

pub struct AeAddr<T> { /* private fields */ }

A specification for an address to the target SCP: a generic network socket address which may also include an application entity title.

These addresses can be serialized and parsed with the syntax {ae_title}@{address}, where the socket address is parsed according to the expectations of the parameter type T.

For the version of the struct in which the AE title part is mandatory, see FullAeAddr.

Example

let addr: AeAddr<SocketAddrV4> = "SCP-STORAGE@127.0.0.1:104".parse()?;
assert_eq!(addr.ae_title(), Some("SCP-STORAGE"));
assert_eq!(addr.socket_addr(), &SocketAddrV4::new([127, 0, 0, 1].into(), 104));
assert_eq!(&addr.to_string(), "SCP-STORAGE@127.0.0.1:104");

// AE title can be missing
let addr: AeAddr<String> = "192.168.1.99:1045".parse()?;
assert_eq!(addr.ae_title(), None);
// but can be provided later
let full_addr: FullAeAddr<_> = addr.with_ae_title("SCP-QUERY");
assert_eq!(full_addr.ae_title(), "SCP-QUERY");
assert_eq!(&full_addr.to_string(), "SCP-QUERY@192.168.1.99:1045");

Implementations

impl<T> AeAddr<T>

pub fn new(ae_title: impl Into<String>, socket_addr: T) -> Self

Create an AE address from its bare constituent parts.

pub fn new_socket_addr(socket_addr: T) -> Self

Create an address with a missing AE title.

pub fn ae_title(&self) -> Option<&str>

Retrieve the application entity title portion, if present.

pub fn socket_addr(&self) -> &T

Retrieve the socket address portion.

pub fn with_ae_title(self, ae_title: impl Into<String>) -> FullAeAddr<T>

Create a new address with the full application entity target, discarding any potentially existing AE title.

pub fn with_default_ae_title(self, ae_title: impl Into<String>) -> FullAeAddr<T>

Create a new address with the full application entity target, using the given AE title if it is missing.

pub fn into_parts(self) -> (Option<String>, T)

Convert the address into its constituent parts.

Trait Implementations

impl<T: Clone> Clone for AeAddr<T>

fn clone(&self) -> AeAddr<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for AeAddr<T>

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

Formats the value using the given formatter.

impl<T> Display for AeAddr<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T> From<FullAeAddr<T>> for AeAddr<T>

fn from(full: FullAeAddr<T>) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for AeAddr<SocketAddr>

This conversion provides a socket address without an AE title.

fn from(socket_addr: SocketAddr) -> Self

Converts to this type from the input type.

impl From<SocketAddrV4> for AeAddr<SocketAddrV4>

This conversion provides an IPv4 socket address without an AE title.

fn from(socket_addr: SocketAddrV4) -> Self

Converts to this type from the input type.

impl From<SocketAddrV6> for AeAddr<SocketAddrV6>

This conversion provides an IPv6 socket address without an AE title.

fn from(socket_addr: SocketAddrV6) -> Self

Converts to this type from the input type.

impl<T> FromStr for AeAddr<T>

where T: FromStr,

type Err = <T as FromStr>::Err

The associated error which can be returned from parsing.

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

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

impl<T: Hash> Hash for AeAddr<T>

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<T: PartialEq> PartialEq for AeAddr<T>

fn eq(&self, other: &AeAddr<T>) -> 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<T> ToSocketAddrs for AeAddr<T>

where T: ToSocketAddrs,

type Iter = <T as ToSocketAddrs>::Iter

Returned iterator over socket addresses which this type may correspond to.

fn to_socket_addrs(&self) -> Result<Self::Iter>

Converts this object to an iterator of resolved SocketAddrs.

impl<'a> TryFrom<&'a str> for AeAddr<String>

type Error = <AeAddr<String> as FromStr>::Err

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Eq> Eq for AeAddr<T>

impl<T> StructuralPartialEq for AeAddr<T>