Struct mdns_sd::ServiceInfo

pub struct ServiceInfo { /* private fields */ }

Complete info about a Service Instance.

We can construct some PTR, one SRV and one TXT record from this info, as well as A (IPv4 Address) records.

Implementations

impl ServiceInfo

pub fn new<Ip: AsIpv4Addrs, P: IntoTxtProperties>( ty_domain: &str, my_name: &str, host_name: &str, host_ipv4: Ip, port: u16, properties: P ) -> Result<Self>

Creates a new service info.

ty_domain is the service type and the domain label, for example “_my-service._udp.local.”.

my_name is the instance name, without the service type suffix.

properties can be None or key/value string pairs, in a type that implements IntoTxtProperties trait. It supports:

• HashMap<String, String>
• Option<HashMap<String, String>>
• slice of tuple: &[(K, V)] where K and V are std::string::ToString.

host_ipv4 can be one or more IPv4 addresses, in a type that implements AsIpv4Addrs trait. It supports:

• Single IPv4: "192.168.0.1"
• Multiple IPv4 separated by comma: "192.168.0.1,192.168.0.2"
• A slice of IPv4: &["192.168.0.1", "192.168.0.2"]
• All the above formats with Ipv4Addr or String instead of &str.

The host TTL and other TTL are set to default values.

pub fn enable_addr_auto(self) -> Self

Indicates that the library should automatically update the addresses of this service, when IPv4 address(es) are added or removed on the host.

pub fn is_addr_auto(&self) -> bool

Returns if the service’s addresses will be updated automatically when the host IPv4 addrs change.

pub fn get_type(&self) -> &str

Returns the service type including the domain label.

For example: “_my-service._udp.local.”.

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

Returns the service subtype including the domain label, if subtype has been defined.

For example: “_printer._sub._http._tcp.local.”.

pub fn get_fullname(&self) -> &str

Returns a reference of the service fullname.

This is useful, for example, in unregister.

pub fn get_properties(&self) -> &TxtProperties

Returns the properties from TXT records.

pub fn get_property(&self, key: &str) -> Option<&TxtProperty>

Returns a property for a given key, where key is case insensitive.

Returns None if key does not exist.

pub fn get_property_val(&self, key: &str) -> Option<Option<&[u8]>>

Returns a property value for a given key, where key is case insensitive.

Returns None if key does not exist.

pub fn get_property_val_str(&self, key: &str) -> Option<&str>

Returns a property value string for a given key, where key is case insensitive.

Returns None if key does not exist.

pub fn get_hostname(&self) -> &str

Returns the service’s hostname.

pub fn get_port(&self) -> u16

Returns the service’s port.

pub fn get_addresses(&self) -> &HashSet<Ipv4Addr>

Returns the service’s addresses

pub fn get_host_ttl(&self) -> u32

Returns the service’s TTL used for SRV and Address records.

pub fn get_other_ttl(&self) -> u32

Returns the service’s TTL used for PTR and TXT records.

pub fn get_priority(&self) -> u16

Returns the service’s priority used in SRV records.

pub fn get_weight(&self) -> u16

Returns the service’s weight used in SRV records.

Trait Implementations

impl Clone for ServiceInfo

fn clone(&self) -> ServiceInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceInfo

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

Formats the value using the given formatter.